home *** CD-ROM | disk | FTP | other *** search
/ Mac-Source 1994 July / Mac-Source_July_1994.iso / Other Langs / MacPerl ƒ / Perl Source ƒ / Perl / PerlHelp < prev    next >
Text File  |  1993-12-15  |  232KB  |  6,056 lines

  1. æKY CopyrightNotice
  2. æC
  3. Larry Wall <lwall@netlabs.com>
  4. Macintosh port by
  5.  
  6.    Matthias Neeracher <neeri@iis.ethz.ch>
  7.    Tim Endres         <time@ice.com>
  8.  
  9. æKY Help
  10. PerlHelp
  11. æKL About…Perl
  12. Perl…Options
  13. Perl…Types
  14. Perl…Syntax
  15. Perl…Compound…Statements
  16. Perl…Simple…Statements
  17. Perl…Expressions
  18. Perl…Operators
  19. Perl…Precedence
  20. Perl…Subroutines
  21. Perl…Regexp
  22. Perl…Formats
  23. Perl…IPC
  24. Perl…Variables
  25. Perl…Packages
  26. Perl…Style
  27. Perl…Debugging
  28. Perl…Environment
  29. Perl…Diagnostics
  30. Perl…Traps
  31. Perl…Errata
  32. Perl…Bugs
  33. Perl…Macintosh…Extensions
  34.  
  35. accept
  36. alarm
  37. atan2
  38. bind
  39. binmode
  40. caller
  41. chdir
  42. chmod
  43. choose
  44. chop
  45. chown
  46. chroot
  47. close
  48. closedir
  49. connect
  50. cos
  51. crypt
  52. dbmclose
  53. dbmopen
  54. defined
  55. delete
  56. die
  57. do
  58. dump
  59. each
  60. endhostent
  61. endprotoent
  62. endservent
  63. eof
  64. eval
  65. exec
  66. exit
  67. exp
  68. fcntl
  69. fileno
  70. flock
  71. fork
  72. getc
  73. gethostbyaddr
  74. gethostbyname
  75. gethostent
  76. getlogin
  77. getpeername
  78. getprotobyname
  79. getprotobynumber
  80. getprotoent
  81. getservbyname
  82. getservbyport
  83. getservent
  84. getsockname
  85. getsockopt
  86. gmtime
  87. goto
  88. grep
  89. hex
  90. index
  91. int
  92. ioctl
  93. join
  94. keys
  95. kill
  96. last
  97. length
  98. link
  99. listen
  100. local
  101. localtime
  102. log
  103. lstat
  104. m
  105. mkdir
  106. msgctl
  107. msgget
  108. msgrcv
  109. msgsnd
  110. next
  111. oct
  112. open
  113. opendir
  114. ord
  115. pack
  116. pipe
  117. pop
  118. print
  119. printf
  120. push
  121. q
  122. rand
  123. read
  124. readdir
  125. readlink
  126. recv
  127. redo
  128. rename
  129. require
  130. reset
  131. return
  132. reverse
  133. rewinddir
  134. rindex
  135. rmdir
  136. s
  137. scalar
  138. seek
  139. seekdir
  140. select
  141. semctl
  142. semget
  143. semop
  144. send
  145. setgrent
  146. sethostent
  147. setnetent
  148. setpgrp
  149. setpriority
  150. setprotoent
  151. setpwent
  152. setservent
  153. setsockopt
  154. shift
  155. shmctl
  156. shmget
  157. shmread
  158. shutdown
  159. sin
  160. sleep
  161. socket
  162. socketpair
  163. sort
  164. splice
  165. split
  166. sprintf
  167. sqrt
  168. srand
  169. stat
  170. study
  171. substr
  172. symlink
  173. syscall
  174. sysread
  175. system
  176. syswrite
  177. tell
  178. telldir
  179. time
  180. times
  181. tr
  182. truncate
  183. umask
  184. undef
  185. unlink
  186. unpack
  187. unshift
  188. utime
  189. values
  190. vec
  191. wait
  192. waitpid
  193. wantarray
  194. warn
  195. write
  196. æKY MacPerl…Help
  197. æC
  198. Welcome to MacPerl!
  199.  
  200. To use the online help, select a word in a window and select this
  201. Help command. For an overview of available help topics, select "Help"
  202. and select the Help command.
  203. æKY Perl
  204. About…Perl
  205. æC
  206. Perl -- Practical Extraction and Report Language
  207.  
  208. Perl is an interpreted language optimized for scanning arbitrary
  209. text files, extracting information from those text files, and
  210. printing reports based on that information. It's also a good
  211. language for many system management tasks. The language is intended
  212. to be practical (easy to use, efficient, complete) rather than
  213. beautiful (tiny, elegant, minimal).  It combines (in the author's
  214. opinion, anyway) some of the best features of C, sed, awk, and sh,
  215. so people familiar with those languages should have little
  216. difficulty with it.  (Language historians will also note some
  217. vestiges of csh, Pascal, and even BASIC-PLUS.) Expression syntax
  218. corresponds quite closely to C expression syntax. Unlike most Unix
  219. utilities, perl does not arbitrarily limit the size of your data--if
  220. you've got the memory, perl can slurp in your whole file as a single
  221. string. Recursion is of unlimited depth.  And the hash tables used by
  222. associative arrays grow as necessary to prevent degraded performance.
  223. Perl uses sophisti- cated pattern matching techniques to scan large
  224. amounts of data very quickly. Although optimized for scanning text,
  225. perl can also deal with binary data, and can make dbm files look like
  226. associative arrays (where dbm is available). Setuid perl scripts are
  227. safer than C programs through a dataflow tracing mechanism which
  228. prevents many stupid security holes.  If you have a problem that
  229. would ordinarily use sed or awk or sh, but it exceeds their
  230. capabilities or must run a little faster, and you don't want to write
  231. the silly thing in C, then perl may be for you.  There are also
  232. translators to turn your sed and awk scripts into perl scripts.
  233. OK, enough hype.
  234.  
  235. Upon startup, perl looks for your script in one of the following
  236. places:
  237.  
  238. 1.  Specified line by line via -e switches on the command line.
  239.  
  240. 2.  Contained in the file specified by the first filename on the
  241.     command line.  (Note that systems supporting the #! notation
  242.     invoke interpreters this way.)
  243.  
  244. 3.  Passed in implicitly via standard input.  This only works if
  245.     there are no filename arguments--to pass arguments to a stdin
  246.     script you must explicitly specify a - for the script name.
  247.  
  248. After locating your script, perl compiles it to an internal form.
  249. If the script is syntactically correct, it is executed.
  250.  
  251. æKY Perl…Options
  252. æC
  253. A single-character option may be combined with the following
  254. option, if any.  This is particularly useful when invoking a
  255. script using the #! construct which only allows one argument.
  256. Example:
  257.  
  258.      #!/usr/bin/perl -spi.bak # same as -s -p -i.bak
  259.      ...
  260.  
  261. Options include:
  262.  
  263. -0digits
  264.      specifies the record separator ($/) as an octal number.  If
  265.      there are no digits, the null character is the separator.
  266.      Other switches may precede or follow the digits.  For exam-
  267.      ple, if you have a version of find which can print filenames
  268.      terminated by the null character, you can say this:
  269.  
  270.                find . -name '*.bak' -print0 | perl -n0e unlink
  271.  
  272.      The special value 00 will cause Perl to slurp files in para-
  273.      graph mode.  The value 0777 will cause Perl to slurp files
  274.      whole since there is no legal character with that value.
  275.  
  276. -a   turns on autosplit mode when used with a -n or -p.  An
  277.      implicit split command to the @F array is done as the first
  278.      thing inside the implicit while loop produced by the -n or -p.
  279.  
  280.                     perl -ane 'print pop(@F), "\n";'
  281.  
  282.      is equivalent to
  283.  
  284.                     while (<>) {
  285.                          @F = split(' ');
  286.                          print pop(@F), "\n";
  287.                     }
  288.  
  289.  
  290. -c   causes perl to check the syntax of the script and then exit
  291.      without executing it.
  292.  
  293. -d   runs the script under the perl debugger.  See the section on
  294.      Debugging.
  295.  
  296. -Dnumber
  297.      sets debugging flags.  To watch how it executes your script,
  298.      use -D14.  (This only works if debugging is compiled into
  299.      your perl.) Another nice value is -D1024, which lists your
  300.      compiled syntax tree.  And -D512 displays compiled regular
  301.      expressions.
  302.  
  303. -e commandline
  304.      may be used to enter one line of script.  Multiple -e com-
  305.      mands may be given to build up a multi-line script.  If -e
  306.      is given, perl will not look for a script filename in the
  307.      argument list.
  308.  
  309. -iextension
  310.      specifies that files processed by the <> construct are to be
  311.      edited in-place.  It does this by renaming the input file,
  312.      opening the output file by the same name, and selecting that
  313.      output file as the default for print statements.  The exten-
  314.      sion, if supplied, is added to the name of the old file to
  315.      make a backup copy.  If no extension is supplied, no backup
  316.      is made.  Saying "perl -p -i.bak -e "s/foo/bar/;" ... " is
  317.      the same as using the script:
  318.  
  319.                     #!/usr/bin/perl -pi.bak
  320.                     s/foo/bar/;
  321.  
  322.      which is equivalent to
  323.  
  324.                     #!/usr/bin/perl
  325.                     while (<>) {
  326.                          if ($ARGV ne $oldargv) {
  327.                               rename($ARGV, $ARGV . '.bak');
  328.                               open(ARGVOUT, ">$ARGV");
  329.                               select(ARGVOUT);
  330.                               $oldargv = $ARGV;
  331.                          }
  332.                          s/foo/bar/;
  333.                     }
  334.                     continue {
  335.                      print;     # this prints to original filename
  336.                     }
  337.                     select(STDOUT);
  338.  
  339.      except that the -i form doesn't need to compare $ARGV to
  340.      $oldargv to know when the filename has changed.  It does,
  341.      however, use ARGVOUT for the selected filehandle.  Note that
  342.      STDOUT is restored as the default output filehandle after
  343.      the loop.
  344.  
  345.      You can use eof to locate the end of each input file, in
  346.      case you want to append to each file, or reset line number-
  347.      ing (see example under eof).
  348.  
  349. -Idirectory
  350.      may be used in conjunction with -P to tell the C preproces-
  351.      sor where to look for include files.  By default
  352.      /usr/include and /usr/lib/perl are searched.
  353.  
  354. -loctnum
  355.      enables automatic line-ending processing.  It has two
  356.      effects: first, it automatically chops the line terminator
  357.      when used with -n or -p , and second, it assigns $\ to have
  358.      the value of octnum so that any print statements will have
  359.      that line terminator added back on.  If octnum is omitted,
  360.      sets $\ to the current value of $/.  For instance, to trim
  361.      lines to 80 columns:
  362.  
  363.                     perl -lpe 'substr($_, 80) = ""'
  364.  
  365.      Note that the assignment $\ = $/ is done when the switch is
  366.      processed, so the input record separator can be different
  367.      than the output record separator if the -l switch is fol-
  368.      lowed by a -0 switch:
  369.  
  370.                     gnufind / -print0 | perl -ln0e 'print "found $_" if -p'
  371.  
  372.      This sets $\ to newline and then sets $/ to the null charac-
  373.      ter.
  374.  
  375. -n   causes perl to assume the following loop around your script,
  376.      which makes it iterate over filename arguments somewhat like
  377.      "sed -n" or awk:
  378.  
  379.                     while (<>) {
  380.                          ...       # your script goes here
  381.                     }
  382.  
  383.      Note that the lines are not printed by default.  See -p to
  384.      have lines printed.  Here is an efficient way to delete all
  385.      files older than a week:
  386.  
  387.                     find . -mtime +7 -print | perl -nle 'unlink;'
  388.  
  389.      This is faster than using the -exec switch of find because
  390.      you don't have to start a process on every filename found.
  391.  
  392. -p   causes perl to assume the following loop around your script,
  393.      which makes it iterate over filename arguments somewhat like
  394.      sed:
  395.  
  396.                     while (<>) {
  397.                          ...       # your script goes here
  398.                     } continue {
  399.                          print;
  400.                     }
  401.  
  402.      Note that the lines are printed automatically.  To suppress
  403.      printing use the -n switch.  A -p overrides a -n switch.
  404.  
  405. -P   causes your script to be run through the C preprocessor
  406.      before compilation by perl.  (Since both comments and cpp
  407.      directives begin with the # character, you should avoid
  408.      starting comments with any words recognized by the C prepro-
  409.      cessor such as "if", "else" or "define".)
  410.  
  411. -s   enables some rudimentary switch parsing for switches on the
  412.      command line after the script name but before any filename
  413.      arguments (or before a --).  Any switch found there is
  414.      removed from @ARGV and sets the corresponding variable in
  415.      the perl script.  The following script prints "true" if and
  416.      only if the script is invoked with a -xyz switch.
  417.  
  418.                     #!/usr/bin/perl -s
  419.                     if ($xyz) { print "true\n"; }
  420.  
  421.  
  422. -S   makes perl use the PATH environment variable to search for
  423.      the script (unless the name of the script starts with a
  424.      slash).  Typically this is used to emulate #! startup on
  425.      machines that don't support #!, in the following manner:
  426.  
  427.                     #!/usr/bin/perl
  428.                     eval "exec /usr/bin/perl -S $0 $*"
  429.                          if $running_under_some_shell;
  430.  
  431.      The system ignores the first line and feeds the script to
  432.      /bin/sh, which proceeds to try to execute the perl script as
  433.      a shell script.  The shell executes the second line as a
  434.      normal shell command, and thus starts up the perl inter-
  435.      preter.  On some systems $0 doesn't always contain the full
  436.      pathname, so the -S tells perl to search for the script if
  437.      necessary.  After perl locates the script, it parses the
  438.      lines and ignores them because the variable
  439.      $running_under_some_shell is never true.  A better construct
  440.      than $* would be ${1+"$@"}, which handles embedded spaces
  441.      and such in the filenames, but doesn't work if the script is
  442.      being interpreted by csh.  In order to start up sh rather
  443.      than csh, some systems may have to replace the #! line with
  444.      a line containing just a colon, which will be politely
  445.      ignored by perl.  Other systems can't control that, and need
  446.      a totally devious construct that will work under any of csh,
  447.      sh or perl, such as the following:
  448.  
  449.                     eval '(exit $?0)' && eval 'exec /usr/bin/perl -S $0 ${1+"$@"}'
  450.                     & eval 'exec /usr/bin/perl -S $0 $argv:q'
  451.                          if 0;
  452.  
  453.  
  454. -u   causes perl to dump core after compiling your script.  You
  455.      can then take this core dump and turn it into an executable
  456.      file by using the undump program (not supplied).  This
  457.      speeds startup at the expense of some disk space (which you
  458.      can minimize by stripping the executable).  (Still, a "hello
  459.      world" executable comes out to about 200K on my machine.) If
  460.      you are going to run your executable as a set-id program
  461.      then you should probably compile it using taintperl rather
  462.      than normal perl.  If you want to execute a portion of your
  463.      script before dumping, use the dump operator instead.  Note:
  464.      availability of undump is platform specific and may not be
  465.      available for a specific port of perl.
  466.  
  467. -U   allows perl to do unsafe operations.  Currently the only
  468.      "unsafe" operation is the unlinking of directories while
  469.      running as superuser.
  470.  
  471. -v   prints the version and patchlevel of your perl executable.
  472.  
  473. -w   prints warnings about identifiers that are mentioned only
  474.      once, and scalar variables that are used before being set.
  475.      Also warns about redefined subroutines, and references to
  476.      undefined filehandles or filehandles opened readonly that
  477.      you are attempting to write on.  Also warns you if you use
  478.      == on values that don't look like numbers, and if your sub-
  479.      routines recurse more than 100 deep.
  480.  
  481. -xdirectory
  482.      tells perl that the script is embedded in a message.  Lead-
  483.      ing garbage will be discarded until the first line that
  484.      starts with #! and contains the string "perl".  Any meaning-
  485.      ful switches on that line will be applied (but only one
  486.      group of switches, as with normal #! processing).  If a
  487.      directory name is specified, Perl will switch to that direc-
  488.      tory before running the script.  The -x switch only controls
  489.      the the disposal of leading garbage.  The script must be
  490.      terminated with __END__ if there is trailing garbage to be
  491.      ignored (the script can process any or all of the trailing
  492.      garbage via the DATA filehandle if desired).
  493. æKY Perl…Types
  494. æC
  495. Perl has three data types: scalars, arrays of scalars, and asso-
  496. ciative arrays of scalars.  Normal arrays are indexed by number,
  497. and associative arrays by string.
  498.  
  499. The interpretation of operations and values in perl sometimes
  500. depends on the requirements of the context around the operation
  501. or value.  There are three major contexts: string, numeric and
  502. array.  Certain operations return array values in contexts want-
  503. ing an array, and scalar values otherwise.  (If this is true of
  504. an operation it will be mentioned in the documentation for that
  505. operation.) Operations which return scalars don't care whether
  506. the context is looking for a string or a number, but scalar vari-
  507. ables and values are interpreted as strings or numbers as
  508. appropriate to the context.  A scalar is interpreted as TRUE in
  509. the boolean sense if it is not the null string or 0.  Booleans
  510. returned by operators are 1 for true and 0 or '' (the null
  511. string) for false.
  512.  
  513. There are actually two varieties of null string: defined and
  514. undefined.  Undefined null strings are returned when there is no
  515. real value for something, such as when there was an error, or at
  516. end of file, or when you refer to an uninitialized variable or
  517. element of an array.  An undefined null string may become defined
  518. the first time you access it, but prior to that you can use the
  519. defined() operator to determine whether the value is defined or
  520. not.
  521.  
  522. References to scalar variables always begin with '$', even when
  523. referring to a scalar that is part of an array.  Thus:
  524.  
  525.           $days           # a simple scalar variable
  526.           $days[28]       # 29th element of array @days
  527.           $days{'Feb'}    # one value from an associative array
  528.           $#days          # last index of array @days
  529.  
  530. but entire arrays or array slices are denoted by '@':
  531.  
  532.           @days           # ($days[0], $days[1],... $days[n])
  533.           @days[3,4,5]    # same as @days[3..5]
  534.           @days{'a','c'}  # same as ($days{'a'},$days{'c'})
  535.  
  536. and entire associative arrays are denoted by '%':
  537.  
  538.           %days           # (key1, val1, key2, val2 ...)
  539.  
  540. Any of these eight constructs may serve as an lvalue, that is,
  541. may be assigned to.  (It also turns out that an assignment is
  542. itself an lvalue in certain contexts--see examples under s, tr
  543. and chop.) Assignment to a scalar evaluates the righthand side in
  544. a scalar context, while assignment to an array or array slice
  545. evaluates the righthand side in an array context.
  546.  
  547. You may find the length of array @days by evaluating "$#days", as
  548. in csh.  (Actually, it's not the length of the array, it's the
  549. subscript of the last element, since there is (ordinarily) a 0th
  550. element.) Assigning to $#days changes the length of the array.
  551. Shortening an array by this method does not actually destroy any
  552. values.  Lengthening an array that was previously shortened
  553. recovers the values that were in those elements.  You can also
  554. gain some measure of efficiency by preextending an array that is
  555. going to get big.  (You can also extend an array by assigning to
  556. an element that is off the end of the array.  This differs from
  557. assigning to $#whatever in that intervening values are set to
  558. null rather than recovered.) You can truncate an array down to
  559. nothing by assigning the null list () to it.  The following are
  560. exactly equivalent
  561.  
  562.      @whatever = ();
  563.      $#whatever = $[ - 1;
  564.  
  565.  
  566. If you evaluate an array in a scalar context, it returns the
  567. length of the array.  The following is always true:
  568.  
  569.      scalar(@whatever) == $#whatever - $[ + 1;
  570.  
  571. If you evaluate an associative array in a scalar context, it returns
  572. a value which is true if and only if the array contains any elements.
  573. (If there are any elements, the value returned is a string consisting
  574. of the number of used buckets and the number of allocated buckets,
  575. separated by a slash.)
  576.  
  577. Multi-dimensional arrays are not directly supported, but see the
  578. discussion of the $; variable later for a means of emulating mul-
  579. tiple subscripts with an associative array.  You could also write
  580. a subroutine to turn multiple subscripts into a single subscript.
  581.  
  582. Every data type has its own namespace.  You can, without fear of
  583. conflict, use the same name for a scalar variable, an array, an
  584. associative array, a filehandle, a subroutine name, and/or a
  585. label.  Since variable and array references always start with
  586. '$', '@', or '%', the "reserved" words aren't in fact reserved
  587. with respect to variable names.  (They ARE reserved with respect
  588. to labels and filehandles, however, which don't have an initial
  589. special character.  Hint: you could say open(LOG,'logfile')
  590. rather than open(log,'logfile').  Using uppercase filehandles
  591. also improves readability and protects you from conflict with
  592. future reserved words.) Case IS significant--"FOO", "Foo" and
  593. "foo" are all different names.  Names which start with a letter
  594. may also contain digits and underscores.  Names which do not
  595. start with a letter are limited to one character, e.g. "$%" or
  596. "$$".  (Most of the one character names have a predefined signi-
  597. ficance to perl.  More later.)
  598.  
  599. Numeric literals are specified in any of the usual floating point
  600. or integer formats:
  601.  
  602.           12345
  603.           12345.67
  604.           .23E-10
  605.           0xffff     # hex
  606.           0377  # octal
  607.           4_294_967_296
  608.  
  609. String literals are delimited by either single or double quotes.
  610. They work much like shell quotes: double-quoted string literals
  611. are subject to backslash and variable substitution; single-quoted
  612. strings are not (except for \' and \\).  The usual backslash
  613. rules apply for making characters such as newline, tab, etc., as
  614. well as some more exotic forms:
  615.  
  616.      \t        tab
  617.      \n        newline
  618.      \r        return
  619.      \f        form feed
  620.      \b        backspace
  621.      \a        alarm (bell)
  622.      \e        escape
  623.      \033      octal char
  624.      \x1b      hex char
  625.      \c[       control char
  626.      \l        lowercase next char
  627.      \u        uppercase next char
  628.      \L        lowercase till \E
  629.      \U        uppercase till \E
  630.      \E        end case modification
  631.  
  632. You can also embed newlines directly in your strings, i.e. they
  633. can end on a different line than they begin.  This is nice, but
  634. if you forget your trailing quote, the error will not be reported
  635. until perl finds another line containing the quote character,
  636. which may be much further on in the script.  Variable substitu-
  637. tion inside strings is limited to scalar variables, normal array
  638. values, and array slices.  (In other words, identifiers beginning
  639. with $ or @, followed by an optional bracketed expression as a
  640. subscript.) The following code segment prints out "The price is
  641. $100."
  642.  
  643.           $Price = '$100';               # not interpreted
  644.           print "The price is $Price.\n";# interpreted
  645.  
  646. Note that you can put curly brackets around the identifier to
  647. delimit it from following alphanumerics.  Also note that a single
  648. quoted string must be separated from a preceding word by a space,
  649. since single quote is a valid character in an identifier (see
  650. Packages).
  651.  
  652. Two special literals are __LINE__ and __FILE__, which represent
  653. the current line number and filename at that point in your pro-
  654. gram.  They may only be used as separate tokens; they will not be
  655. interpolated into strings.  In addition, the token __END__ may be
  656. used to indicate the logical end of the script before the actual
  657. end of file.  Any following text is ignored, but may be read via
  658. the DATA filehandle. (The DATA filehandle may read data only from
  659. the main script, but not from any required file or evaluated string.)
  660. The two control characters ^D and ^Z are synonyms for __END__.
  661.  
  662. A word that doesn't have any other interpretation in the grammar
  663. will be treated as if it had single quotes around it.  For this
  664. purpose, a word consists only of alphanumeric characters and
  665. underline, and must start with an alphabetic character.  As with
  666. filehandles and labels, a bare word that consists entirely of
  667. lowercase letters risks conflict with future reserved words, and
  668. if you use the -w switch, Perl will warn you about any such
  669. words.
  670.  
  671. Array values are interpolated into double-quoted strings by join-
  672. ing all the elements of the array with the delimiter specified in
  673. the $" variable, space by default.  (Since in versions of perl
  674. prior to 3.0 the @ character was not a metacharacter in double-
  675. quoted strings, the interpolation of @array, $array[EXPR],
  676. @array[LIST], $array{EXPR}, or @array{LIST} only happens if array
  677. is referenced elsewhere in the program or is predefined.) The
  678. following are equivalent:
  679.  
  680.      $temp = join($",@ARGV);
  681.      system "echo $temp";
  682.  
  683.      system "echo @ARGV";
  684.  
  685.  
  686. Within search patterns (which also undergo double-quotish substi-
  687. tution) there is a bad ambiguity:  Is /$foo[bar]/ to be inter-
  688. preted as /${foo}[bar]/ (where [bar] is a character class for the
  689. regular expression) or as /${foo[bar]}/ (where [bar] is the sub-
  690. script to array @foo)?  If @foo doesn't otherwise exist, then
  691. it's obviously a character class.  If @foo exists, perl takes a
  692. good guess about [bar], and is almost always right.  If it does
  693. guess wrong, or if you're just plain paranoid, you can force the
  694. correct interpretation with curly brackets as above.
  695.  
  696. A line-oriented form of quoting is based on the shell here-is
  697. syntax.  Following a << you specify a string to terminate the
  698. quoted material, and all lines following the current line down to
  699. the terminating string are the value of the item.  The terminat-
  700. ing string may be either an identifier (a word), or some quoted
  701. text.  If quoted, the type of quotes you use determines the
  702. treatment of the text, just as in regular quoting.  An unquoted
  703. identifier works like double quotes.  There must be no space
  704. between the << and the identifier.  (If you put a space it will
  705. be treated as a null identifier, which is valid, and matches the
  706. first blank line--see Merry Christmas example below.) The ter-
  707. minating string must appear by itself (unquoted and with no sur-
  708. rounding whitespace) on the terminating line.
  709.  
  710. print <<EOF;        # same as above
  711. The price is $Price.
  712. EOF
  713.  
  714. print <<"EOF";      # same as above
  715. The price is $Price.
  716. EOF
  717.  
  718. print << x 10;      # null identifier is delimiter
  719. Merry Christmas!
  720.  
  721. print <<`EOC`;      # execute commands
  722. echo hi there
  723. echo lo there
  724. EOC
  725.  
  726. print <<foo, <<bar; # you can stack them
  727. I said foo.
  728. foo
  729. I said bar.
  730. bar
  731.  
  732. Array literals are denoted by separating individual values by
  733. commas, and enclosing the list in parentheses:
  734.  
  735.      (LIST)
  736.  
  737. In a context not requiring an array value, the value of the array
  738. literal is the value of the final element, as in the C comma
  739. operator.  For example,
  740.  
  741.           @foo = ('cc', '-E', $bar);
  742.  
  743. assigns the entire array value to array foo, but
  744.  
  745.           $foo = ('cc', '-E', $bar);
  746.  
  747. assigns the value of variable bar to variable foo.  Note that the
  748. value of an actual array in a scalar context is the length of the
  749. array; the following assigns to $foo the value 3:
  750.  
  751.           @foo = ('cc', '-E', $bar);
  752.           $foo = @foo;         # $foo gets 3
  753.  
  754. You may have an optional comma before the closing parenthesis of
  755. an array literal, so that you can say:
  756.  
  757.      @foo = (
  758.      1,
  759.      2,
  760.      3,
  761.      );
  762.  
  763. When a LIST is evaluated, each element of the list is evaluated
  764. in an array context, and the resulting array value is interpo-
  765. lated into LIST just as if each individual element were a member
  766. of LIST.  Thus arrays lose their identity in a LIST--the list
  767.  
  768.      (@foo,@bar,&SomeSub)
  769.  
  770. contains all the elements of @foo followed by all the elements of
  771. @bar, followed by all the elements returned by the subroutine
  772. named SomeSub.
  773.  
  774. A list value may also be subscripted like a normal array.  Exam-
  775. ples:
  776.  
  777.      $time = (stat($file))[8];     # stat returns array value
  778.      $digit = ('a','b','c','d','e','f')[$digit-10];
  779.      return (pop(@foo),pop(@foo))[0];
  780.  
  781.  
  782. Array lists may be assigned to if and only if each element of the
  783. list is an lvalue:
  784.  
  785.           ($a, $b, $c) = (1, 2, 3);
  786.  
  787.           ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00);
  788.  
  789. The final element may be an array or an associative array:
  790.  
  791.           ($a, $b, @rest) = split;
  792.           local($a, $b, %rest) = @_;
  793.  
  794.  
  795. You can actually put an array anywhere in the list, but the first
  796. array in the list will soak up all the values, and anything after
  797. it will get a null value.  This may be useful in a local().
  798.  
  799. An associative array literal contains pairs of values to be
  800. interpreted as a key and a value:
  801.  
  802.           # same as map assignment above
  803.           %map = ('red',0x00f,'blue',0x0f0,'green',0xf00);
  804.  
  805. Array assignment in a scalar context returns the number of ele-
  806. ments produced by the expression on the right side of the assign-
  807. ment:
  808.  
  809.      $x = (($foo,$bar) = (3,2,1)); # set $x to 3, not 2
  810.  
  811.  
  812. There are several other pseudo-literals that you should know
  813. about.  If a string is enclosed by backticks (grave accents), it
  814. first undergoes variable substitution just like a double quoted
  815. string.  It is then interpreted as a command, and the output of
  816. that command is the value of the pseudo-literal, like in a shell.
  817. In a scalar context, a single string consisting of all the output
  818. is returned.  In an array context, an array of values is
  819. returned, one for each line of output.  (You can set $/ to use a
  820. different line terminator.) The command is executed each time the
  821. pseudo-literal is evaluated.  The status value of the command is
  822. returned in $? (see Predefined Names for the interpretation of
  823. $?).  Unlike in csh, no translation is done on the return data--
  824. newlines remain newlines.  Unlike in any of the shells, single
  825. quotes do not hide variable names in the command from interpreta-
  826. tion.  To pass a $ through to the shell you need to hide it with
  827. a backslash.
  828.  
  829. Evaluating a filehandle in angle brackets yields the next line
  830. from that file (newline included, so it's never false until EOF,
  831. at which time an undefined value is returned).  Ordinarily you
  832. must assign that value to a variable, but there is one situation
  833. where an automatic assignment happens.  If (and only if) the
  834. input symbol is the only thing inside the conditional of a while
  835. loop, the value is automatically assigned to the variable "$_".
  836. (This may seem like an odd thing to you, but you'll use the con-
  837. struct in almost every perl script you write.) Anyway, the fol-
  838. lowing lines are equivalent to each other:
  839.  
  840.           while ($_ = <STDIN>) { print; }
  841.           while (<STDIN>) { print; }
  842.           for (;<STDIN>;) { print; }
  843.           print while $_ = <STDIN>;
  844.           print while <STDIN>;
  845.  
  846. The filehandles STDIN, STDOUT and STDERR are predefined.  (The
  847. filehandles stdin, stdout and stderr will also work except in
  848. packages, where they would be interpreted as local identifiers
  849. rather than global.) Additional filehandles may be created with
  850. the open function.
  851.  
  852. If a <FILEHANDLE> is used in a context that is looking for an
  853. array, an array consisting of all the input lines is returned,
  854. one line per array element.  It's easy to make a LARGE data space
  855. this way, so use with care.
  856.  
  857. The null filehandle <> is special and can be used to emulate the
  858. behavior of sed and awk.  Input from <> comes either from stan-
  859. dard input, or from each file listed on the command line.  Here's
  860. how it works: the first time <> is evaluated, the ARGV array is
  861. checked, and if it is null, $ARGV[0] is set to '-', which when
  862. opened gives you standard input.  The ARGV array is then pro-
  863. cessed as a list of filenames.  The loop
  864.  
  865.      while (<>) {
  866.                     ...            # code for each line
  867.      }
  868.  
  869. is equivalent to the following Perl-like pseudo code:
  870.  
  871.      unshift(@ARGV, '-') if $#ARGV < $[;
  872.      while ($ARGV = shift) {
  873.                     open(ARGV, $ARGV);
  874.                     while (<ARGV>) {
  875.                          ...       # code for each line
  876.                     }
  877.      }
  878.  
  879. except that it isn't as cumbersome to say, and will actually 
  880. work.  It really does shift array ARGV and put the current
  881. filename into variable ARGV.  It also uses filehandle ARGV
  882. internally -- <> is just a synonym for <ARGV>, which is magical.
  883. (The pseudo code above doesn't work because it treats <ARGV> as 
  884. non-magical.)
  885.  
  886. You can modify @ARGV before the first <> as long as the array ends up
  887. containing the list of filenames you really want.
  888.  
  889. Line numbers ($.) continue as if the input was one big happy file.
  890. (But see example under eof for how to reset line numbers on each file.)
  891.  
  892. If you want to set @ARGV to your own list of files, go right
  893. ahead.  If you want to pass switches into your script, you can
  894. put a loop on the front like this:
  895.  
  896.      while ($_ = $ARGV[0], /^-/) {
  897.                     shift;
  898.                last if /^--$/;
  899.                     /^-D(.*)/ && ($debug = $1);
  900.                     /^-v/ && $verbose++;
  901.                     ...       # other switches
  902.      }
  903.      while (<>) {
  904.                     ...       # code for each line
  905.      }
  906.  
  907.  
  908. The <> symbol will return FALSE only once.  If you call it again
  909. after this it will assume you are processing another @ARGV list,
  910. and if you haven't set @ARGV, will input from STDIN.
  911.  
  912. If the string inside the angle brackets is a reference to a
  913. scalar variable (e.g. <$foo>), then that variable contains the
  914. name of the filehandle to input from.
  915.  
  916. If the string inside angle brackets is not a filehandle, it is
  917. interpreted as a filename pattern to be globbed, and either an
  918. array of filenames or the next filename in the list is returned,
  919. depending on context.  One level of $ interpretation is done
  920. first, but you can't say <$foo> because that's an indirect
  921. filehandle as explained in the previous paragraph.  You could
  922. insert curly brackets to force interpretation as a filename glob:
  923. <${foo}>.  Example:
  924.  
  925.      while (<*.c>) {
  926.                     chmod 0644, $_;
  927.      }
  928.  
  929. is equivalent to
  930.  
  931.      open(foo, "echo *.c | tr -s ' \t\r\f' '\\012\\012\\012\\012'|");
  932.      while (<foo>) {
  933.                     chop;
  934.                     chmod 0644, $_;
  935.      }
  936.  
  937. In fact, it's currently implemented that way.  (Which means it
  938. will not work on filenames with spaces in them unless you have
  939. /bin/csh on your machine.) Of course, the shortest way to do the
  940. above is:
  941.  
  942.      chmod 0644, <*.c>;
  943.  
  944. æKY Perl…Syntax
  945. æC
  946. A perl script consists of a sequence of declarations and com-
  947. mands.  The only things that need to be declared in perl are
  948. report formats and subroutines.  See the sections below for more
  949. information on those declarations.  All uninitialized user-
  950. created objects are assumed to start with a null or 0 value until
  951. they are defined by some explicit operation such as assignment.
  952. The sequence of commands is executed just once, unlike in sed and
  953. awk scripts, where the sequence of commands is executed for each
  954. input line.  While this means that you must explicitly loop over
  955. the lines of your input file (or files), it also means you have
  956. much more control over which files and which lines you look at.
  957. (Actually, I'm lying--it is possible to do an implicit loop with
  958. either the -n or -p switch.)
  959.  
  960. A declaration can be put anywhere a command can, but has no
  961. effect on the execution of the primary sequence of commands--
  962. declarations all take effect at compile time.  Typically all the
  963. declarations are put at the beginning or the end of the script.
  964.  
  965. Perl is, for the most part, a free-form language.  (The only
  966. exception to this is format declarations, for fairly obvious rea-
  967. sons.) Comments are indicated by the # character, and extend to
  968. the end of the line.  If you attempt to use /* */ C comments, it
  969. will be interpreted either as division or pattern matching,
  970. depending on the context.  So don't do that.
  971.  
  972. SEE ALSO
  973.  
  974. æKL Perl…Compound…Statements
  975. Perl…Simple…Statements
  976. Perl…Expressions
  977. æKY Perl…Compound…Statements
  978. æC
  979. In perl, a sequence of commands may be treated as one command by
  980. enclosing it in curly brackets.  We will call this a BLOCK.
  981.  
  982. The following compound commands may be used to control flow:
  983.  
  984.      if (EXPR) BLOCK
  985.      if (EXPR) BLOCK else BLOCK
  986.      if (EXPR) BLOCK elsif (EXPR) BLOCK ... else BLOCK
  987.      LABEL while (EXPR) BLOCK
  988.      LABEL while (EXPR) BLOCK continue BLOCK
  989.      LABEL for (EXPR; EXPR; EXPR) BLOCK
  990.      LABEL foreach VAR (ARRAY) BLOCK
  991.      LABEL BLOCK continue BLOCK
  992.  
  993. Note that, unlike C and Pascal, these are defined in terms of
  994. BLOCKs, not statements.  This means that the curly brackets are
  995. required--no dangling statements allowed.  If you want to write
  996. conditionals without curly brackets there are several other ways
  997. to do it.  The following all do the same thing:
  998.  
  999.      if (!open(foo)) { die "Can't open $foo: $!"; }
  1000.      die "Can't open $foo: $!" unless open(foo);
  1001.      open(foo) || die "Can't open $foo: $!"; # foo or bust!
  1002.      open(foo) ? 'hi mom' : die "Can't open $foo: $!";
  1003.                               # a bit exotic, that last one
  1004.  
  1005.  
  1006. The if statement is straightforward.  Since BLOCKs are always
  1007. bounded by curly brackets, there is never any ambiguity about
  1008. which if an else goes with.  If you use unless in place of if,
  1009. the sense of the test is reversed.
  1010.  
  1011. The while statement executes the block as long as the expression
  1012. is true (does not evaluate to the null string or 0).  The LABEL
  1013. is optional, and if present, consists of an identifier followed
  1014. by a colon.  The LABEL identifies the loop for the loop control
  1015. statements next, last, and redo (see below).  If there is a con-
  1016. tinue BLOCK, it is always executed just before the conditional is
  1017. about to be evaluated again, similarly to the third part of a for
  1018. loop in C.  Thus it can be used to increment a loop variable,
  1019. even when the loop has been continued via the next statement
  1020. (similar to the C "continue" statement).
  1021.  
  1022. If the word while is replaced by the word until, the sense of the
  1023. test is reversed, but the conditional is still tested before the
  1024. first iteration.
  1025.  
  1026. In either the if or the while statement, you may replace "(EXPR)"
  1027. with a BLOCK, and the conditional is true if the value of the
  1028. last command in that block is true.
  1029.  
  1030. The for loop works exactly like the corresponding while loop:
  1031.  
  1032.      for ($i = 1; $i < 10; $i++) {
  1033.                     ...
  1034.      }
  1035.  
  1036. is the same as
  1037.  
  1038.      $i = 1;
  1039.      while ($i < 10) {
  1040.                     ...
  1041.      } continue {
  1042.                     $i++;
  1043.      }
  1044.  
  1045. The foreach loop iterates over a normal array value and sets the
  1046. variable VAR to be each element of the array in turn.  The vari-
  1047. able is implicitly local to the loop, and regains its former
  1048. value upon exiting the loop.  The "foreach" keyword is actually
  1049. identical to the "for" keyword, so you can use "foreach" for rea-
  1050. dability or "for" for brevity.  If VAR is omitted, $_ is set to
  1051. each value.  If ARRAY is an actual array (as opposed to an
  1052. expression returning an array value), you can modify each element
  1053. of the array by modifying VAR inside the loop.  Examples:
  1054.  
  1055.      for (@ary) { s/foo/bar/; }
  1056.  
  1057.      foreach $elem (@elements) {
  1058.                     $elem *= 2;
  1059.      }
  1060.  
  1061.      for ((10,9,8,7,6,5,4,3,2,1,'BOOM')) {
  1062.                     print $_, "\n"; sleep(1);
  1063.      }
  1064.  
  1065.      for (1..15) { print "Merry Christmas\n"; }
  1066.  
  1067.      foreach $item (split(/:[\\\n:]*/, $ENV{'TERMCAP'})) {
  1068.                     print "Item: $item\n";
  1069.      }
  1070.  
  1071.  
  1072. The BLOCK by itself (labeled or not) is equivalent to a loop that
  1073. executes once.  Thus you can use any of the loop control state-
  1074. ments in it to leave or restart the block.  The continue block is
  1075. optional.  This construct is particularly nice for doing case
  1076. structures.
  1077.  
  1078.      foo: {
  1079.                     if (/^abc/) { $abc = 1; last foo; }
  1080.                     if (/^def/) { $def = 1; last foo; }
  1081.                     if (/^xyz/) { $xyz = 1; last foo; }
  1082.                     $nothing = 1;
  1083.      }
  1084.  
  1085. There is no official switch statement in perl, because there are
  1086. already several ways to write the equivalent.  In addition to the
  1087. above, you could write
  1088.  
  1089.      foo: {
  1090.                     $abc = 1, last foo  if /^abc/;
  1091.                     $def = 1, last foo  if /^def/;
  1092.                     $xyz = 1, last foo  if /^xyz/;
  1093.                     $nothing = 1;
  1094.      }
  1095.  
  1096. or
  1097.  
  1098.      foo: {
  1099.                     /^abc/ && do { $abc = 1; last foo; };
  1100.                     /^def/ && do { $def = 1; last foo; };
  1101.                     /^xyz/ && do { $xyz = 1; last foo; };
  1102.                     $nothing = 1;
  1103.      }
  1104.  
  1105. or
  1106.  
  1107.      foo: {
  1108.                     /^abc/ && ($abc = 1, last foo);
  1109.                     /^def/ && ($def = 1, last foo);
  1110.                     /^xyz/ && ($xyz = 1, last foo);
  1111.                     $nothing = 1;
  1112.      }
  1113.  
  1114. or even
  1115.  
  1116.      if (/^abc/)
  1117.                     { $abc = 1; }
  1118.      elsif (/^def/)
  1119.                     { $def = 1; }
  1120.      elsif (/^xyz/)
  1121.                     { $xyz = 1; }
  1122.      else
  1123.                     {$nothing = 1;}
  1124.  
  1125. As it happens, these are all optimized internally to a switch
  1126. structure, so perl jumps directly to the desired statement, and
  1127. you needn't worry about perl executing a lot of unnecessary
  1128. statements when you have a string of 50 elsifs, as long as you
  1129. are testing the same simple scalar variable using ==, eq, or pat-
  1130. tern matching as above.  (If you're curious as to whether the
  1131. optimizer has done this for a particular case statement, you can
  1132. use the -D1024 switch to list the syntax tree before execution.)
  1133.  
  1134. æKY Perl…Simple…Statements
  1135. æC
  1136. The only kind of simple statement is an expression evaluated for
  1137. its side effects.  Every simple statement must be terminated with a
  1138. semicolon, unless it is the final statement in a block, in which case
  1139. the semicolon is optional. (Semicolon is still encouraged there if the
  1140. block takes up more than one line).
  1141.  
  1142. Any simple statement may optionally be followed by a single
  1143. modifier, just before the terminating semicolon.  The possible
  1144. modifiers are:
  1145.  
  1146.      if EXPR
  1147.      unless EXPR
  1148.      while EXPR
  1149.      until EXPR
  1150.  
  1151. The if and unless modifiers have the expected semantics.  The
  1152. while and until modifiers also have the expected semantics (con-
  1153. ditional evaluated first), except when applied to a do-BLOCK or a
  1154. do-SUBROUTINE command, in which case the block executes once
  1155. before the conditional is evaluated.  This is so that you can
  1156. write loops like:
  1157.  
  1158.      do {
  1159.                     $_ = <STDIN>;
  1160.                     ...
  1161.      } until $_ eq ".\n";
  1162.  
  1163. (See the do operator below.  Note also that the loop control com-
  1164. mands described later will NOT work in this construct, since
  1165. modifiers don't take loop labels.  Sorry.)
  1166.  
  1167. æKY Perl…Expressions
  1168. æC
  1169. Since perl expressions work almost exactly like C expressions,
  1170. only the differences will be mentioned here.
  1171.  
  1172. Here's what perl has that C doesn't:
  1173.  
  1174. **      The exponentiation operator.
  1175.  
  1176. **=     The exponentiation assignment operator.
  1177.  
  1178. ()      The null list, used to initialize an array to null.
  1179.  
  1180. .       Concatenation of two strings.
  1181.  
  1182. .=      The concatenation assignment operator.
  1183.  
  1184. eq      String equality (== is numeric equality).  For a mnemonic
  1185.         just think of "eq" as a string.  (If you are used to the
  1186.         awk behavior of using == for either string or numeric
  1187.         equality based on the current form of the comparands,
  1188.         beware!  You must be explicit here.)
  1189.  
  1190. ne      String inequality (!= is numeric inequality).
  1191.  
  1192. lt      String less than.
  1193.  
  1194. gt      String greater than.
  1195.  
  1196. le      String less than or equal.
  1197.  
  1198. ge      String greater than or equal.
  1199.  
  1200. cmp     String comparison, returning -1, 0, or 1.
  1201.  
  1202. <=>     Numeric comparison, returning -1, 0, or 1.
  1203.  
  1204. =~      Certain operations search or modify the string "$_" by
  1205.         default.  This operator makes that kind of operation work
  1206.         on some other string.  The right argument is a search
  1207.         pattern, substitution, or translation.  The left argument
  1208.         is what is supposed to be searched, substituted, or
  1209.         translated instead of the default "$_".  The return value
  1210.         indicates the success of the operation.  (If the right
  1211.         argument is an expression other than a search pattern,
  1212.         substitution, or translation, it is interpreted as a
  1213.         search pattern at run time.  This is less efficient than
  1214.         an explicit search, since the pattern must be compiled
  1215.         every time the expression is evaluated.) The precedence
  1216.         of this operator is lower than unary minus and
  1217.         autoincrement/decrement, but higher than everything else.
  1218.  
  1219. !~      Just like =~ except the return value is negated.
  1220.  
  1221. x       The repetition operator.  Returns a string consisting of
  1222.         the left operand repeated the number of times specified
  1223.         by the right operand.  In an array context, if the left
  1224.         operand is a list in parens, it repeats the list.
  1225.  
  1226.              print '-' x 80;               # print row of dashes
  1227.              print '-' x80;                # illegal, x80 is identifier
  1228.  
  1229.              print "\t" x ($tab/8), ' ' x ($tab%8);  # tab over
  1230.  
  1231.              @ones = (1) x 80;               # an array of 80 1's
  1232.              @ones = (5) x @ones;          # set all elements to 5
  1233.  
  1234. x=      The repetition assignment operator.  Only works on
  1235.         scalars.
  1236.  
  1237. ..      The range operator, which is really two different opera-
  1238.         tors depending on the context.  In an array context,
  1239.         returns an array of values counting (by ones) from the
  1240.         left value to the right value.  This is useful for writ-
  1241.         ing "for (1..10)" loops and for doing slice operations on
  1242.         arrays.
  1243.  
  1244.         In a scalar context, .. returns a boolean value.  The
  1245.         operator is bistable, like a flip-flop, and emulates the
  1246.         line-range (comma) operator of sed, awk, and various
  1247.         editors.  Each .. opera tor maintains its own boolean state.
  1248.         It is false as long as its left operand is false.  Once the
  1249.         left operand is true, the range operator stays true until
  1250.         the right operand is true, AFTER which the range operator
  1251.         becomes false again.  (It doesn't become false till the next 
  1252.         time the range operator is evaluated.  It can test the right
  1253.         operand and become false on the same evaluation it became
  1254.         true (as in awk), but it still returns true once. If you don't 
  1255.         want it to test the right operand till the next evaluation
  1256.         (as in sed), use three dots (...) instead of two.) The right
  1257.         operand is not evaluated while the operator is in the "false"
  1258.         state, and the left operand is not evaluated while the operator
  1259.         is in the "true" state.  The precedence is a little lower than
  1260.         || and &&.  The value returned is either the null string for
  1261.         false, or a sequence number (beginning with 1) for true.  The
  1262.         sequence number is reset for each range encountered.  The final
  1263.         sequence number in a range has the string 'E0' appended to it,
  1264.         which doesn't affect its numeric value, but gives you something 
  1265.         to search for if you want to exclude the endpoint.  You can
  1266.         exclude the beginning point by waiting for the sequence number
  1267.         to be greater than 1.  If either operand of scalar .. is static,
  1268.         that operand is implicitly compared to the $. variable, the
  1269.         current line number.  Examples:
  1270.  
  1271.         As a scalar operator:
  1272.              if (101 .. 200) { print; }     # print 2nd hundred lines
  1273.  
  1274.              next line if (1 .. /^$/); # skip header lines
  1275.  
  1276.              s/^/> / if (/^$/ .. eof());    # quote body
  1277.  
  1278.         As an array operator:
  1279.              for (101 .. 200) { print; }    # print $_ 100 times
  1280.  
  1281.              @foo = @foo[$[ .. $#foo]; # an expensive no-op
  1282.              @foo = @foo[$#foo-4 .. $#foo]; # slice last 5 items
  1283.  
  1284. -x      A file test.  This unary operator takes one argument,
  1285.         either a filename or a filehandle, and tests the associ-
  1286.         ated file to see if something is true about it.  If the
  1287.         argument is omitted, tests $_, except for -t, which tests
  1288.         STDIN.  It returns 1 for true and '' for false, or the
  1289.         undefined value if the file doesn't exist.  Precedence is
  1290.         higher than logical and relational operators, but lower
  1291.         than arithmetic operators.  The operator may be any of:
  1292.              -r   File is readable by effective uid/gid.
  1293.              -w   File is writable by effective uid/gid.
  1294.              -x   File is executable by effective uid/gid.
  1295.              -o   File is owned by effective uid.
  1296.              -R   File is readable by real uid/gid.
  1297.              -W   File is writable by real uid/gid.
  1298.              -X   File is executable by real uid/gid.
  1299.              -O   File is owned by real uid.
  1300.              -e   File exists.
  1301.              -z   File has zero size.
  1302.              -s   File has non-zero size (returns size).
  1303.              -f   File is a plain file.
  1304.              -d   File is a directory.
  1305.              -l   File is a symbolic link.
  1306.              -p   File is a named pipe (FIFO).
  1307.              -S   File is a socket.
  1308.              -b   File is a block special file.
  1309.              -c   File is a character special file.
  1310.              -u   File has setuid bit set.
  1311.              -g   File has setgid bit set.
  1312.              -k   File has sticky bit set.
  1313.              -t   Filehandle is opened to a tty.
  1314.              -T   File is a text file.
  1315.              -B   File is a binary file (opposite of -T).
  1316.              -M   Age of file in days when script started.
  1317.              -A   Same for access time.
  1318.              -C   Same for inode change time.
  1319.  
  1320.         The interpretation of the file permission operators -r,
  1321.         -R, -w, -W, -x and -X is based solely on the mode of the
  1322.         file and the uids and gids of the user.  There may be
  1323.         other reasons you can't actually read, write or execute
  1324.         the file.  Also note that, for the superuser, -r, -R, -w
  1325.         and -W always return 1, and -x and -X return 1 if any
  1326.         execute bit is set in the mode.  Scripts run by the
  1327.         superuser may thus need to do a stat() in order to deter-
  1328.         mine the actual mode of the file, or temporarily set the
  1329.         uid to something else.
  1330.  
  1331.         Example:
  1332.              while (<>) {
  1333.                   chop;
  1334.                   next unless -f $_;  # ignore specials
  1335.                   ...
  1336.              }
  1337.  
  1338.         Note that -s/a/b/ does not do a negated substitution.
  1339.         Saying -exp($foo) still works as expected, however--only
  1340.         single letters following a minus are interpreted as file
  1341.         tests.
  1342.  
  1343.         The -T and -B switches work as follows.  The first block
  1344.         or so of the file is examined for odd characters such as
  1345.         strange control codes or metacharacters.  If too many odd
  1346.         characters (>10%) are found, it's a -B file, otherwise
  1347.         it's a -T file.  Also, any file containing null in the
  1348.         first block is considered a binary file.  If -T or -B is
  1349.         used on a filehandle, the current stdio buffer is exam-
  1350.         ined rather than the first block.  Both -T and -B return
  1351.         TRUE on a null file, or a file at EOF when testing a
  1352.         filehandle.
  1353.  
  1354. If any of the file tests (or either stat operator) are given the
  1355. special filehandle consisting of a solitary underline, then the
  1356. stat structure of the previous file test (or stat operator) is
  1357. used, saving a system call.  (This doesn't work with -t, and you
  1358. need to remember that lstat and -l will leave values in the stat
  1359. structure for the symbolic link, not the real file.) Example:
  1360.  
  1361.      print "Can do.\n" if -r $a || -w _ || -x _;
  1362.  
  1363.      stat($filename);
  1364.      print "Readable\n" if -r _;
  1365.      print "Writable\n" if -w _;
  1366.      print "Executable\n" if -x _;
  1367.      print "Setuid\n" if -u _;
  1368.      print "Setgid\n" if -g _;
  1369.      print "Sticky\n" if -k _;
  1370.      print "Text\n" if -T _;
  1371.      print "Binary\n" if -B _;
  1372.  
  1373.  
  1374. Here is what C has that perl doesn't:
  1375.  
  1376. unary &     Address-of operator.
  1377.  
  1378. unary *     Dereference-address operator.
  1379.  
  1380. (TYPE)      Type casting operator.
  1381.  
  1382. Like C, perl does a certain amount of expression evaluation at
  1383. compile time, whenever it determines that all of the arguments to
  1384. an operator are static and have no side effects.  In particular,
  1385. string concatenation happens at compile time between literals
  1386. that don't do variable substitution.  Backslash interpretation
  1387. also happens at compile time.  You can say
  1388.  
  1389.      'Now is the time for all' . "\n" .
  1390.      'good men to come to.'
  1391.  
  1392. and this all reduces to one string internally.
  1393.  
  1394. The autoincrement operator has a little extra built-in magic to
  1395. it.  If you increment a variable that is numeric, or that has
  1396. ever been used in a numeric context, you get a normal increment.
  1397. If, however, the variable has only been used in string contexts
  1398. since it was set, and has a value that is not null and matches
  1399. the pattern /^[a-zA-Z]*[0-9]*$/, the increment is done as a
  1400. string, preserving each character within its range, with carry:
  1401.  
  1402.      print ++($foo = '99');   # prints '100'
  1403.      print ++($foo = 'a0');   # prints 'a1'
  1404.      print ++($foo = 'Az');   # prints 'Ba'
  1405.      print ++($foo = 'zz');   # prints 'aaa'
  1406.  
  1407. The autodecrement is not magical.
  1408.  
  1409. The range operator (in an array context) makes use of the magical
  1410. autoincrement algorithm if the minimum and maximum are strings.
  1411. You can say
  1412.  
  1413.      @alphabet = ('A' .. 'Z');
  1414.  
  1415. to get all the letters of the alphabet, or
  1416.  
  1417.      $hexdigit = (0 .. 9, 'a' .. 'f')[$num & 15];
  1418.  
  1419. to get a hexadecimal digit, or
  1420.  
  1421.      @z2 = ('01' .. '31');  print @z2[$mday];
  1422.  
  1423. to get dates with leading zeros.  (If the final value specified
  1424. is not in the sequence that the magical increment would produce,
  1425. the sequence goes until the next value would be longer than the
  1426. final value specified.)
  1427.  
  1428. The || and && operators differ from C's in that, rather than
  1429. returning 0 or 1, they return the last value evaluated. Thus, a
  1430. portable way to find out the home directory might be:
  1431.  
  1432.      $home = $ENV{'HOME'} || $ENV{'LOGDIR'} ||
  1433.                (getpwuid($<))[7] || die "You're homeless!\n";
  1434.  
  1435. æKY Perl…Operators
  1436. æC
  1437. Along with the literals and variables mentioned earlier, the
  1438. operations in the following section can serve as terms in an
  1439. expression.  Some of these operations take a LIST as an argument.
  1440.  
  1441. Such a list can consist of any combination of scalar arguments or
  1442. array values; the array values will be included in the list as if
  1443. each individual element were interpolated at that point in the
  1444. list, forming a longer single-dimensional array value.  Elements
  1445. of the LIST should be separated by commas.  If an operation is
  1446. listed both with and without parentheses around its arguments, it
  1447. means you can either use it as a unary operator or as a function
  1448. call.  To use it as a function call, the next token on the same
  1449. line must be a left parenthesis.  (There may be intervening white
  1450. space.) Such a function then has highest precedence, as you would
  1451. expect from a function.  If any token other than a left parenthesis
  1452. follows, then it is a unary operator, with a pre cedence depending
  1453. only on whether it is a LIST operator or not. LIST operators have
  1454. lowest precedence.  All other unary operators have a precedence
  1455. greater than relational operators but less than arithmetic operators.
  1456. See the section on Precedence.
  1457.  
  1458. For operators that can be used in either a scalar or array context,
  1459. failure is generally indicated in a scalar context by returning the
  1460. undefined value, and in an array context by returning the null list.
  1461. Remember though that THERE IS NO GENERAL RULE FOR CONVERTING A LIST
  1462. INTO A SCALAR. Each operator decides which sort of scalar it would
  1463. be most appropriate to return.  Some operators return the length of
  1464. the list that would have been returned in an array context.  Some
  1465. operators return the first value in the list.  Some operators return
  1466. the last value in the list.  Some operators return a count of
  1467. successful operations.  In general, they do what you want, unless
  1468. you want consistency.
  1469.  
  1470. æKL accept
  1471. alarm
  1472. atan2
  1473. bind
  1474. binmode
  1475. caller
  1476. chdir
  1477. chmod
  1478. chop
  1479. chown
  1480. chroot
  1481. close
  1482. closedir
  1483. connect
  1484. cos
  1485. crypt
  1486. dbmclose
  1487. dbmopen
  1488. defined
  1489. delete
  1490. die
  1491. do
  1492. do
  1493. do
  1494. dump
  1495. each
  1496. eof
  1497. eval
  1498. exec
  1499. exit
  1500. exp
  1501. fcntl
  1502. fileno
  1503. flock
  1504. fork
  1505. getc
  1506. getlogin
  1507. getpeername
  1508. getpgrp
  1509. getppid
  1510. getpwnam
  1511. getsockname
  1512. getsockopt
  1513. gmtime
  1514. goto
  1515. grep
  1516. hex
  1517. index
  1518. int
  1519. ioctl
  1520. join
  1521. keys
  1522. kill
  1523. last
  1524. length
  1525. link
  1526. listen
  1527. local
  1528. localtime
  1529. log
  1530. lstat
  1531. m
  1532. mkdir
  1533. msgctl
  1534. msgget
  1535. msgsnd
  1536. msgrcv
  1537. next
  1538. oct
  1539. open
  1540. opendir
  1541. ord
  1542. pack
  1543. pipe
  1544. pop
  1545. print
  1546. printf
  1547. push
  1548. q
  1549. rand
  1550. read
  1551. readdir
  1552. readlink
  1553. recv
  1554. redo
  1555. rename
  1556. require
  1557. reset
  1558. return
  1559. reverse
  1560. rewinddir
  1561. rindex
  1562. rmdir
  1563. s
  1564. scalar
  1565. seek
  1566. seekdir
  1567. select
  1568. select
  1569. semctl
  1570. semget
  1571. semop
  1572. send
  1573. setpgrp
  1574. setpriority
  1575. setsockopt
  1576. shift
  1577. shmctl
  1578. shmget
  1579. shmread
  1580. shutdown
  1581. sin
  1582. sleep
  1583. socket
  1584. socketpair
  1585. sort
  1586. splice
  1587. split
  1588. sprintf
  1589. sqrt
  1590. srand
  1591. stat
  1592. study
  1593. substr
  1594. symlink
  1595. syscall
  1596. sysread
  1597. system
  1598. syswrite
  1599. tell
  1600. telldir
  1601. time
  1602. times
  1603. tr
  1604. truncate
  1605. umask
  1606. undef
  1607. unlink
  1608. unpack
  1609. unshift
  1610. utime
  1611. values
  1612. vec
  1613. wait
  1614. waitpid
  1615. wantarray
  1616. warn
  1617. write
  1618. æKY accept
  1619. æDT accept(NEWSOCKET,GENERICSOCKET)
  1620. æC accept(NEWSOCKET,GENERICSOCKET)
  1621.  
  1622.           Does the same thing that the accept system call does.
  1623.           Returns true if it succeeded, false otherwise.  See exam-
  1624.           ple in section on Interprocess Communication.
  1625. æKY alarm
  1626. æDT alarm(SECONDS)
  1627. æC alarm(SECONDS)
  1628. alarm SECONDS
  1629.  
  1630.           Arranges to have a SIGALRM delivered to this process
  1631.           after the specified number of seconds (minus 1, actually)
  1632.           have elapsed.  Thus, alarm(15) will cause a SIGALRM at
  1633.           some point more than 14 seconds in the future.  Only one
  1634.           timer may be counting at once.  Each call disables the
  1635.           previous timer, and an argument of 0 may be supplied to
  1636.           cancel the previous timer without starting a new one.
  1637.           The returned value is the amount of time remaining on the
  1638.           previous timer.
  1639. æKY atan2
  1640. æDT atan2(Y,X)
  1641. æC atan2(Y,X)
  1642.  
  1643.           Returns the arctangent of Y/X in the range -PI to PI.
  1644. æKY bind
  1645. æDT bind(SOCKET,NAME)
  1646. æC bind(SOCKET,NAME)
  1647.  
  1648.           Does the same thing that the bind system call does.
  1649.           Returns true if it succeeded, false otherwise.  NAME
  1650.           should be a packed address of the proper type for the
  1651.           socket.  See example in section on Interprocess
  1652.           Communication.
  1653. æKY binmode
  1654. æDT binmode(FILEHANDLE)
  1655. æC binmode(FILEHANDLE)
  1656. binmode FILEHANDLE
  1657.  
  1658.           Arranges for the file to be read in "binary" mode in
  1659.           operating systems that distinguish between binary and
  1660.           text files.  Files that are not read in binary mode have
  1661.           CR LF sequences translated to LF on input and LF
  1662.           translated to CR LF on output.  Binmode has no effect
  1663.           under Unix.  If FILEHANDLE is an expression, the value is
  1664.           taken as the name of the filehandle.
  1665. æKY caller
  1666. æDT caller(EXPR)
  1667. æC caller(EXPR)
  1668. caller
  1669.           Returns the context of the current subroutine call:
  1670.  
  1671.                          ($package,$filename,$line) = caller;
  1672.  
  1673.           With EXPR, returns some extra information that the
  1674.           debugger uses to print a stack trace.  The value of EXPR
  1675.           indicates how many call frames to go back before the
  1676.           current one.
  1677. æKY chdir
  1678. æDT chdir(EXPR)
  1679. æC chdir(EXPR)
  1680. chdir EXPR
  1681.  
  1682.           Changes the working directory to EXPR, if possible.  If
  1683.           EXPR is omitted, changes to home directory.  Returns 1
  1684.           upon success, 0 otherwise.  See example under die.
  1685. æKY chmod
  1686. æDT chmod(LIST)
  1687. æC chmod(LIST)
  1688. chmod LIST
  1689.  
  1690.           Changes the permissions of a list of files.  The first
  1691.           element of the list must be the numerical mode.  Returns
  1692.           the number of files successfully changed.
  1693.  
  1694.                          $cnt = chmod 0755, 'foo', 'bar';
  1695.                          chmod 0755, @executables;
  1696. æKY chop
  1697. æDT chop(LIST)
  1698. æC chop(LIST)
  1699. chop(VARIABLE)
  1700. chop VARIABLE
  1701. chop
  1702.  
  1703.           Chops off the last character of a string and returns the
  1704.           character chopped.  It's used primarily to remove the
  1705.           newline from the end of an input record, but is much more
  1706.           efficient than s/\n// because it neither scans nor copies
  1707.           the string.  If VARIABLE is omitted, chops $_.  Example:
  1708.  
  1709.                          while (<>) {
  1710.                               chop;     # avoid \n on last field
  1711.                               @array = split(/:/);
  1712.                               ...
  1713.                          }
  1714.  
  1715.           You can actually chop anything that's an lvalue, includ-
  1716.           ing an assignment:
  1717.  
  1718.                          chop($cwd = `pwd`);
  1719.                          chop($answer = <STDIN>);
  1720.  
  1721.           If you chop a list, each element is chopped.  Only the
  1722.           value of the last chop is returned.
  1723. æKY chown
  1724. æDT chown(LIST)
  1725. æC chown(LIST)
  1726. chown LIST
  1727.  
  1728.           Changes the owner (and group) of a list of files.  The
  1729.           first two elements of the list must be the NUMERICAL uid
  1730.           and gid, in that order.  Returns the number of files suc-
  1731.           cessfully changed.
  1732.  
  1733.                          $cnt = chown $uid, $gid, 'foo', 'bar';
  1734.                          chown $uid, $gid, @filenames;
  1735.  
  1736.           Here's an example of looking up non-numeric uids in the passwd file:
  1737.  
  1738.                          print "User: ";
  1739.                          $user = <STDIN>;
  1740.                          chop($user);
  1741.                          print "Files: "
  1742.                          $pattern = <STDIN>;
  1743.                          chop($pattern);
  1744.                          open(pass, '/etc/passwd')
  1745.                               || die "Can't open passwd: $!\n";
  1746.                          while (<pass>) {
  1747.                               ($login,$pass,$uid,$gid) = split(/:/);
  1748.                               $uid{$login} = $uid;
  1749.                               $gid{$login} = $gid;
  1750.                          }
  1751.                          @ary = <${pattern}>;     # get filenames
  1752.                          if ($uid{$user} eq '') {
  1753.                               die "$user not in passwd file";
  1754.                          }
  1755.                          else {
  1756.                               chown $uid{$user}, $gid{$user}, @ary;
  1757.                          }
  1758. æKY chroot
  1759. æDT chroot(FILENAME)
  1760. æC chroot(FILENAME)
  1761. chroot FILENAME
  1762.  
  1763.           Does the same as the system call of that name.  If you
  1764.           don't know what it does, don't worry about it.  If
  1765.           FILENAME is omitted, does chroot to $_.
  1766. æKY close
  1767. æDT close(FILEHANDLE)
  1768. æC close(FILEHANDLE)
  1769. close FILEHANDLE
  1770.  
  1771.           Closes the file or pipe associated with the file handle.
  1772.           You don't have to close FILEHANDLE if you are immediately
  1773.           going to do another open on it, since open will close it
  1774.           for you.  (See open.) However, an explicit close on an
  1775.           input file resets the line counter ($.), while the impli-
  1776.           cit close done by open does not.  Also, closing a pipe
  1777.           will wait for the process executing on the pipe to com-
  1778.           plete, in case you want to look at the output of the pipe
  1779.           afterwards.  Closing a pipe explicitly also puts the
  1780.           status value of the command into $?.  Example:
  1781.  
  1782.                          open(OUTPUT, '|sort >foo');   # pipe to sort
  1783.                          ...  # print stuff to output
  1784.                          close OUTPUT;       # wait for sort to finish
  1785.                          open(INPUT, 'foo'); # get sort's results
  1786.  
  1787.           FILEHANDLE may be an expression whose value gives the
  1788.           real filehandle name.
  1789. æKY closedir
  1790. æDT closedir(DIRHANDLE)
  1791. æC closedir(DIRHANDLE)
  1792. closedir DIRHANDLE
  1793.  
  1794.           Closes a directory opened by opendir().
  1795. æKY connect
  1796. æDT connect(SOCKET,NAME)
  1797. æC connect(SOCKET,NAME)
  1798.  
  1799.           Does the same thing that the connect system call does.
  1800.           Returns true if it succeeded, false otherwise.  NAME
  1801.           should be a package address of the proper type for the
  1802.           socket.  See example in section on Interprocess Communi-
  1803.           cation.
  1804. æKY cos
  1805. æDT cos(EXPR)
  1806. æC cos(EXPR)
  1807. cos EXPR
  1808.  
  1809.           Returns the cosine of EXPR (expressed in radians).  If
  1810.           EXPR is omitted takes cosine of $_.
  1811. æKY crypt
  1812. æDT crypt(PLAINTEXT,SALT)
  1813. æC crypt(PLAINTEXT,SALT)
  1814.  
  1815.           Encrypts a string exactly like the crypt() function in
  1816.           the C library.  Useful for checking the password file for
  1817.           lousy passwords.  Only the guys wearing white hats should
  1818.           do this.
  1819. æKY dbmclose
  1820. æDT dbmclose(ASSOC_ARRAY)
  1821. æC dbmclose(ASSOC_ARRAY)
  1822. dbmclose ASSOC_ARRAY
  1823.  
  1824.           Breaks the binding between a dbm file and an associative
  1825.           array.  The values remaining in the associative array are
  1826.           meaningless unless you happen to want to know what was in
  1827.           the cache for the dbm file.  This function is only useful
  1828.           if you have ndbm.
  1829. æKY dbmopen
  1830. æDT dbmopen(ASSOC,DBNAME,MODE)
  1831. æC dbmopen(ASSOC,DBNAME,MODE)
  1832.  
  1833.           This binds a dbm or ndbm file to an associative array.
  1834.           ASSOC is the name of the associative array.  (Unlike nor-
  1835.           mal open, the first argument is NOT a filehandle, even
  1836.           though it looks like one).  DBNAME is the name of the
  1837.           database (without the .dir or .pag extension).  If the
  1838.           database does not exist, it is created with protection
  1839.           specified by MODE (as modified by the umask).  If your
  1840.           system only supports the older dbm functions, you may
  1841.           perform only one dbmopen in your program.  If your system
  1842.           has neither dbm nor ndbm, calling dbmopen produces a
  1843.           fatal error.
  1844.  
  1845.           Values assigned to the associative array prior to the
  1846.           dbmopen are lost.  A certain number of values from the
  1847.           dbm file are cached in memory.  By default this number is
  1848.           64, but you can increase it by preallocating that number
  1849.           of garbage entries in the associative array before the
  1850.           dbmopen.  You can flush the cache if necessary with the
  1851.           reset command.
  1852.  
  1853.           If you don't have write access to the dbm file, you can
  1854.           only read associative array variables, not set them.  If
  1855.           you want to test whether you can write, either use file
  1856.           tests or try setting a dummy array entry inside an eval,
  1857.           which will trap the error.
  1858.  
  1859.           Note that functions such as keys() and values() may
  1860.           return huge array values when used on large dbm files.
  1861.           You may prefer to use the each() function to iterate over
  1862.           large dbm files.  Example:
  1863.  
  1864.                          # print out history file offsets
  1865.                          dbmopen(HIST,'/usr/lib/news/history',0666);
  1866.                          while (($key,$val) = each %HIST) {
  1867.                               print $key, ' = ', unpack('L',$val), "\n";
  1868.                          }
  1869.                          dbmclose(HIST);
  1870. æKY defined
  1871. æDT defined(EXPR)
  1872. æC defined(EXPR)
  1873. defined EXPR
  1874.  
  1875.           Returns a boolean value saying whether the lvalue EXPR
  1876.           has a real value or not.  Many operations return the
  1877.           undefined value under exceptional conditions, such as end
  1878.           of file, uninitialized variable, system error and such.
  1879.           This function allows you to distinguish between an unde-
  1880.           fined null string and a defined null string with opera-
  1881.           tions that might return a real null string, in particular
  1882.           referencing elements of an array.  You may also check to
  1883.           see if arrays or subroutines exist.  Use on predefined
  1884.           variables is not guaranteed to produce intuitive results.
  1885.           Examples:
  1886.  
  1887.                          print if defined $switch{'D'};
  1888.                          print "$val\n" while defined($val = pop(@ary));
  1889.                          die "Can't readlink $sym: $!"
  1890.                               unless defined($value = readlink $sym);
  1891.                          eval '@foo = ()' if defined(@foo);
  1892.                          die "No XYZ package defined" unless defined %_XYZ;
  1893.                          sub foo { defined &$bar ? &$bar(@_) : die "No bar"; }
  1894.  
  1895.           See also undef.
  1896. æKY delete
  1897. æDT delete $ASSOC{KEY}
  1898. æC delete $ASSOC{KEY}
  1899.  
  1900.           Deletes the specified value from the specified associa-
  1901.           tive array.  Returns the deleted value, or the undefined
  1902.           value if nothing was deleted.  Deleting from $ENV{} modi-
  1903.           fies the environment.  Deleting from an array bound to a
  1904.           dbm file deletes the entry from the dbm file.
  1905.  
  1906.           The following deletes all the values of an associative
  1907.           array:
  1908.  
  1909.                          foreach $key (keys %ARRAY) {
  1910.                               delete $ARRAY{$key};
  1911.                          }
  1912.  
  1913.           (But it would be faster to use the reset command.  Saying
  1914.           undef %ARRAY is faster yet.)
  1915. æKY die
  1916. æDT die(LIST)
  1917. æC die(LIST)
  1918. die LIST
  1919.  
  1920.           Outside of an eval, prints the value of LIST to STDERR
  1921.           and exits with the current value of $!  (errno).  If $!
  1922.           is 0, exits with the value of ($? >> 8) (`command`
  1923.           status).  If ($? >> 8) is 0, exits with 255.  Inside an
  1924.           eval, the error message is stuffed into $@ and the eval
  1925.           is terminated with the undefined value.
  1926.  
  1927.           Equivalent examples:
  1928.  
  1929.                          die "Can't cd to spool: $!\n"
  1930.                               unless chdir '/usr/spool/news';
  1931.  
  1932.                          chdir '/usr/spool/news' || die "Can't cd to spool: $!\n"
  1933.  
  1934.  
  1935.           If the value of EXPR does not end in a newline, the
  1936.           current script line number and input line number (if any)
  1937.           are also printed, and a newline is supplied.  Hint: some-
  1938.           times appending ", stopped" to your message will cause it
  1939.           to make better sense when the string "at foo line 123" is
  1940.           appended.  Suppose you are running script "canasta".
  1941.  
  1942.                          die "/etc/games is no good";
  1943.                          die "/etc/games is no good, stopped";
  1944.  
  1945.           produce, respectively
  1946.  
  1947.                          /etc/games is no good at canasta line 123.
  1948.                          /etc/games is no good, stopped at canasta line 123.
  1949.  
  1950.           See also exit.
  1951. æKY do
  1952. æDT do BLOCK
  1953. æC do BLOCK
  1954.  
  1955.           Returns the value of the last command in the sequence of
  1956.           commands indicated by BLOCK.  When modified by a loop
  1957.           modifier, executes the BLOCK once before testing the loop
  1958.           condition.  (On other statements the loop modifiers test
  1959.           the conditional first.)
  1960.  
  1961. do SUBROUTINE (LIST)
  1962.  
  1963.           Executes a SUBROUTINE declared by a sub declaration, and
  1964.           returns the value of the last expression evaluated in
  1965.           SUBROUTINE.  If there is no subroutine by that name, pro-
  1966.           duces a fatal error.  (You may use the "defined" operator
  1967.           to determine if a subroutine exists.) If you pass arrays
  1968.           as part of LIST you may wish to pass the length of the
  1969.           array in front of each array.  (See the section on sub-
  1970.           routines later on.) SUBROUTINE may be a scalar variable,
  1971.           in which case the name of the sub routine to execute is
  1972.           taken from the variable.  The parentheses are required to
  1973.           avoid confusion with the "do EXPR" form.
  1974.  
  1975.           As an alternate form, you may call a subroutine by pre-
  1976.           fixing the name with an ampersand: &foo(@args).  If you
  1977.           aren't passing any arguments, you don't have to use
  1978.           parentheses.  If you omit the parentheses, no @_ array is
  1979.           passed to the subroutine.  The & form is also used to
  1980.           specify subroutines to the defined and undef operators:
  1981.  
  1982.                          if (defined &$var) { &$var($parm); undef &$var; }
  1983.  
  1984. do EXPR
  1985.  
  1986.           Uses the value of EXPR as a filename and executes the
  1987.           contents of the file as a perl script.  Its primary use
  1988.           is to include subroutines from a perl subroutine library.
  1989.  
  1990.                          do 'stat.pl';
  1991.  
  1992.           is just like
  1993.  
  1994.                          eval `cat stat.pl`;
  1995.  
  1996.           except that it's more efficient, more concise, keeps
  1997.           track of the current filename for error messages, and
  1998.           searches all the -I libraries if the file isn't in the
  1999.           current directory (see also the @INC array in Predefined
  2000.           Names).  It's the same, however, in that it does reparse
  2001.           the file every time you call it, so if you are going to
  2002.           use the file inside a loop you might prefer to use -P and
  2003.           #include, at the expense of a little more startup time.
  2004.           (The main problem with #include is that cpp doesn't grok
  2005.           # comments--a workaround is to use ";#" for standalone
  2006.           comments.) Note that the following are NOT equivalent:
  2007.  
  2008.                          do $foo;  # eval a file
  2009.                          do $foo();     # call a subroutine
  2010.  
  2011.           Note that inclusion of library routines is better done
  2012.           with the "require" operator.
  2013. æKY dump
  2014. æDT dump LABEL
  2015. æC dump LABEL
  2016.  
  2017.           This causes an immediate core dump.  Primarily this is so
  2018.           that you can use the undump program to turn your core
  2019.           dump into an executable binary after having initialized
  2020.           all your variables at the beginning of the program.  When
  2021.           the new binary is executed it will begin by executing a
  2022.           "goto LABEL" (with all the restrictions that goto
  2023.           suffers).  Think of it as a goto with an intervening core
  2024.           dump and reincarnation.  If LABEL is omitted, restarts
  2025.           the program from the top.  WARNING: any files opened at
  2026.           the time of the dump will NOT be open any more when the
  2027.           program is reincarnated, with possible resulting confu-
  2028.           sion on the part of perl.  See also -u.
  2029.  
  2030.           Example:
  2031.  
  2032.                          #!/usr/bin/perl
  2033.                          require 'getopt.pl';
  2034.                          require 'stat.pl';
  2035.                          %days = (
  2036.                          'Sun',1,
  2037.                          'Mon',2,
  2038.                          'Tue',3,
  2039.                          'Wed',4,
  2040.                          'Thu',5,
  2041.                          'Fri',6,
  2042.                          'Sat',7);
  2043.  
  2044.                          dump QUICKSTART if $ARGV[0] eq '-d';
  2045.  
  2046.                     QUICKSTART:
  2047.                          do Getopt('f');
  2048. æKY each
  2049. æDT each(ASSOC_ARRAY)
  2050. æC each(ASSOC_ARRAY)
  2051. each ASSOC_ARRAY
  2052.  
  2053.           Returns a 2 element array consisting of the key and value
  2054.           for the next value of an associative array, so that you
  2055.           can iterate over it.  Entries are returned in an
  2056.           apparently random order.  When the array is entirely
  2057.           read, a null array is returned (which when assigned pro-
  2058.           duces a FALSE (0) value).  The next call to each() after
  2059.           that will start iterating again.  The iterator can be
  2060.           reset only by reading all the elements from the array.
  2061.           You must not modify the array while iterating over it.
  2062.           There is a single iterator for each associative array,
  2063.           shared by all each(), keys() and values() function calls
  2064.           in the program.  The following prints out your environ-
  2065.           ment like the printenv program, only in a different
  2066.           order:
  2067.  
  2068.                          while (($key,$value) = each %ENV) {
  2069.                               print "$key=$value\n";
  2070.                          }
  2071.  
  2072.           See also keys() and values().
  2073. æKY eof
  2074. æDT eof(FILEHANDLE)
  2075. æC eof(FILEHANDLE)
  2076. eof()
  2077. eof
  2078.           Returns 1 if the next read on FILEHANDLE will return end
  2079.           of file, or if FILEHANDLE is not open.  FILEHANDLE may be
  2080.           an expression whose value gives the real filehandle name.
  2081.           (Note that this function actually reads a character and
  2082.           then ungetc's it, so it is not very useful in an interac-
  2083.           tive context.) An eof without an argument returns the eof
  2084.           status for the last file read.  Empty parentheses () may
  2085.           be used to indicate the pseudo file formed of the files
  2086.           listed on the command line, i.e. eof() is reasonable to
  2087.           use inside a while (<>) loop to detect the end of only
  2088.           the last file.  Use eof(ARGV) or eof without the
  2089.           parentheses to test EACH file in a while (<>) loop.
  2090.           Examples:
  2091.  
  2092.                          # insert dashes just before last line of last file
  2093.                          while (<>) {
  2094.                               if (eof()) {
  2095.                                    print "--------------\n";
  2096.                               }
  2097.                               print;
  2098.                          }
  2099.  
  2100.                          # reset line numbering on each input file
  2101.                          while (<>) {
  2102.                               print "$.\t$_";
  2103.                               if (eof) {     # Not eof().
  2104.                                    close(ARGV);
  2105.                               }
  2106.                          }
  2107. æKY eval
  2108. æDT eval(EXPR)
  2109. æC eval(EXPR)
  2110. eval EXPR
  2111. eval BLOCK
  2112.  
  2113.           EXPR is parsed and executed as if it were a little perl
  2114.           program.  It is executed in the context of the current
  2115.           perl program, so that any variable settings, subroutine
  2116.           or format definitions remain afterwards.  The value
  2117.           returned is the value of the last expression evaluated,
  2118.           just as with subroutines.  If there is a syntax error or
  2119.           runtime error, or a die statement is executed, an unde-
  2120.           fined value is returned by eval, and $@ is set to the
  2121.           error message.  If there was no error, $@ is guaranteed
  2122.           to be a null string.  If EXPR is omitted, evaluates $_.
  2123.           The final semicolon, if any, may be omitted from the
  2124.           expression.
  2125.  
  2126.           Note that, since eval traps otherwise-fatal errors, it is
  2127.           useful for determining whether a particular feature (such
  2128.           as dbmopen or symlink) is implemented.  It is also Perl's
  2129.           exception trapping mechanism, where the die operator is
  2130.           used to raise exceptions.
  2131.  
  2132.           If the code to be executed doesn't vary, you may use the 
  2133.           eval-BLOCK form to trap run-time errors without incurring
  2134.           the penalty of recompiling each time. The error, if any,
  2135.           is still returned in $@.
  2136.           Evaluating a single-quoted string (as EXPR) has the same
  2137.           effect, except that the eval-EXPR form reports syntax errors
  2138.           at run time via $@, whereas the eval-BLOCK form reports syntax
  2139.           errors at compile time.  The eval-EXPR form is optimized to
  2140.           eval-BLOCK the first time it succeeds.  (Since the replacement
  2141.           side of a substitution is considered a single-quoted string
  2142.           when you use the e modifier, the same optimization occurs there.)
  2143.           Examples:
  2144.  
  2145.                         # make divide-by-zero non-fatal
  2146.                         eval { $answer = $a / $b; }; warn $@ if $@;
  2147.  
  2148.                         # optimized to same thing after first use
  2149.                         eval '$answer = $a / $b'; warn $@ if $@;
  2150.  
  2151.                         # a compile-time error
  2152.                         eval { $answer = };
  2153.  
  2154.                         # a run-time error
  2155.                         eval '$answer =';    # sets $@
  2156.  
  2157. æKY exec
  2158. æDT exec(LIST)
  2159. æC exec(LIST)
  2160. exec LIST
  2161.  
  2162.           If there is more than one argument in LIST, or if LIST is
  2163.           an array with more than one value, calls execvp() with
  2164.           the arguments in LIST.  If there is only one scalar argu-
  2165.           ment, the argument is checked for shell metacharacters.
  2166.           If there are any, the entire argument is passed to
  2167.           "/bin/sh -c" for parsing.  If there are none, the argu-
  2168.           ment is split into words and passed directly to execvp(),
  2169.           which is more efficient.  Note: exec (and system) do not
  2170.           flush your output buffer, so you may need to set $| to
  2171.           avoid lost output.  Examples:
  2172.  
  2173.                          exec '/bin/echo', 'Your arguments are: ', @ARGV;
  2174.                          exec "sort $outfile | uniq";
  2175.  
  2176.  
  2177.           If you don't really want to execute the first argument,
  2178.           but want to lie to the program you are executing about
  2179.           its own name, you can specify the program you actually
  2180.           want to run by assigning that to a variable and putting
  2181.           the name of the variable in front of the LIST without a
  2182.           comma.  (This always forces interpretation of the LIST as
  2183.           a multi-valued list, even if there is only a single
  2184.           scalar in the list.) Example:
  2185.  
  2186.                          $shell = '/bin/csh';
  2187.                          exec $shell '-sh';       # pretend it's a login shell
  2188. æKY exit
  2189. æDT exit(EXPR)
  2190. æC exit(EXPR)
  2191. exit EXPR
  2192.  
  2193.           Evaluates EXPR and exits immediately with that value.
  2194.           Example:
  2195.  
  2196.                          $ans = <STDIN>;
  2197.                          exit 0 if $ans =~ /^[Xx]/;
  2198.  
  2199.           See also die.  If EXPR is omitted, exits with 0 status.
  2200. æKY exp
  2201. æDT exp(EXPR)
  2202. æC exp(EXPR)
  2203. exp EXPR
  2204.  
  2205.           Returns e to the power of EXPR.  If EXPR is omitted,
  2206.           gives exp($_).
  2207. æKY fcntl
  2208. æDT fcntl(FILEHANDLE,FUNCTION,SCALAR)
  2209. æC fcntl(FILEHANDLE,FUNCTION,SCALAR)
  2210.  
  2211.           Implements the fcntl(2) function.  You'll probably have
  2212.           to say
  2213.  
  2214.                          require "fcntl.ph"; # probably /usr/local/lib/perl/fcntl.ph
  2215.  
  2216.           first to get the correct function definitions.  If
  2217.           fcntl.ph doesn't exist or doesn't have the correct defin-
  2218.           itions you'll have to roll your own, based on your C
  2219.           header files such as <sys/fcntl.h>.  (There is a perl
  2220.           script called h2ph that comes with the perl kit which may
  2221.           help you in this.) Argument processing and value return
  2222.           works just like ioctl below.  Note that fcntl will pro-
  2223.           duce a fatal error if used on a machine that doesn't
  2224.           implement fcntl(2).
  2225. æKY fileno
  2226. æDT fileno(FILEHANDLE)
  2227. æC fileno(FILEHANDLE)
  2228. fileno FILEHANDLE
  2229.  
  2230.           Returns the file descriptor for a filehandle.  Useful for
  2231.           constructing bitmaps for select().  If FILEHANDLE is an
  2232.           expression, the value is taken as the name of the
  2233.           filehandle.
  2234. æKY flock
  2235. æDT flock(FILEHANDLE,OPERATION)
  2236. æC flock(FILEHANDLE,OPERATION)
  2237.  
  2238.           Calls flock(2) on FILEHANDLE.  See manual page for
  2239.           flock(2) for definition of OPERATION.  Returns true for
  2240.           success, false on failure.  Will produce a fatal error if
  2241.           used on a machine that doesn't implement flock(2).
  2242.           Here's a mailbox appender for BSD systems.
  2243.  
  2244.                          $LOCK_SH = 1;
  2245.                          $LOCK_EX = 2;
  2246.                          $LOCK_NB = 4;
  2247.                          $LOCK_UN = 8;
  2248.  
  2249.                          sub lock {
  2250.                          flock(MBOX,$LOCK_EX);
  2251.                          # and, in case someone appended
  2252.                          # while we were waiting...
  2253.                          seek(MBOX, 0, 2);
  2254.                          }
  2255.  
  2256.                          sub unlock {
  2257.                          flock(MBOX,$LOCK_UN);
  2258.                          }
  2259.  
  2260.                          open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}")
  2261.                               || die "Can't open mailbox: $!";
  2262.  
  2263.                          do lock();
  2264.                          print MBOX $msg,"\n\n";
  2265.                          do unlock();
  2266. æKY fork
  2267. æDT fork
  2268. æC fork
  2269.  
  2270.           Does a fork() call.  Returns the child pid to the parent
  2271.           process and 0 to the child process.  Note: unflushed
  2272.           buffers remain unflushed in both processes, which means
  2273.           you may need to set $| to avoid duplicate output.
  2274. æKY getc
  2275. æDT getc(FILEHANDLE)
  2276. æC getc(FILEHANDLE)
  2277. getc FILEHANDLE
  2278. getc
  2279.  
  2280.           Returns the next character from the input file attached
  2281.           to FILEHANDLE, or a null string at EOF.  If FILEHANDLE is
  2282.           omitted, reads from STDIN.
  2283. æKY getlogin
  2284. æDT getlogin
  2285. æC getlogin
  2286.  
  2287.           Returns the current login from /etc/utmp, if any.  If
  2288.           null, use getpwuid.
  2289.  
  2290.                          $login = getlogin || (getpwuid($<))[0] || "Some-
  2291.           body";
  2292. æKY getpeername
  2293. æDT getpeername(SOCKET)
  2294. æC getpeername(SOCKET)
  2295.  
  2296.           Returns the packed sockaddr address of other end of the
  2297.           SOCKET connection.
  2298.  
  2299.                          # An internet sockaddr
  2300.                          $sockaddr = 'S n a4 x8';
  2301.                          $hersockaddr = getpeername(S);
  2302.                          ($family, $port, $heraddr) =
  2303.                                    unpack($sockaddr,$hersockaddr);
  2304. æKY getpgrp
  2305. æDT getpgrp(PID)
  2306. æC getpgrp(PID)
  2307. getpgrp PID
  2308.  
  2309.           Returns the current process group for the specified PID,
  2310.           0 for the current process.  Will produce a fatal error if
  2311.           used on a machine that doesn't implement getpgrp(2).  If
  2312.           EXPR is omitted, returns process group of current pro-
  2313.           cess.
  2314. æKY getppid
  2315. æDT getppid
  2316. æC getppid
  2317.  
  2318.           Returns the process id of the parent process.
  2319. æKY getpriority
  2320. æDT getpriority(WHICH,WHO)
  2321. æC getpriority(WHICH,WHO)
  2322.  
  2323.           Returns the current priority for a process, a process
  2324.           group, or a user.  (See getpriority(2).) Will produce a
  2325.           fatal error if used on a machine that doesn't implement
  2326.           getpriority(2).
  2327. æKY getpwnam
  2328. getgrnam
  2329. gethostbyname
  2330. getnetbyname
  2331. getprotobyname
  2332. getpwuid
  2333. getgrgid
  2334. getservbyname
  2335. gethostbyaddr
  2336. getnetbyaddr
  2337. getprotobynumber
  2338. getservbyport
  2339. getpwent
  2340. getgrent
  2341. gethostent
  2342. getnetent
  2343. getprotoent
  2344. getservent
  2345. setpwent
  2346. setgrent
  2347. sethostent
  2348. setnetent
  2349. setprotoent
  2350. setservent
  2351. endpwent
  2352. endgrent
  2353. endhostent
  2354. endnetent
  2355. endprotoent
  2356. endservent
  2357. æC getpwnam(NAME)
  2358. getgrnam(NAME)
  2359. gethostbyname(NAME)
  2360. getnetbyname(NAME)
  2361. getprotobyname(NAME)
  2362. getpwuid(UID)
  2363. getgrgid(GID)
  2364. getservbyname(NAME,PROTO)
  2365. gethostbyaddr(ADDR,ADDRTYPE)
  2366. getnetbyaddr(ADDR,ADDRTYPE)
  2367. getprotobynumber(NUMBER)
  2368. getservbyport(PORT,PROTO)
  2369. getpwent
  2370. getgrent
  2371. gethostent
  2372. getnetent
  2373. getprotoent
  2374. getservent
  2375. setpwent
  2376. setgrent
  2377. sethostent(STAYOPEN)
  2378. setnetent(STAYOPEN)
  2379. setprotoent(STAYOPEN)
  2380. setservent(STAYOPEN)
  2381. endpwent
  2382. endgrent
  2383. endhostent
  2384. endnetent
  2385. endprotoent
  2386. endservent
  2387.  
  2388.           These routines perform the same functions as their coun-
  2389.           terparts in the system library.  Within an array context,
  2390.           the return values from the various get routines are as
  2391.           follows:
  2392.  
  2393.                          ($name,$passwd,$uid,$gid,
  2394.                               $quota,$comment,$gcos,$dir,$shell) = getpw...
  2395.                          ($name,$passwd,$gid,$members) = getgr...
  2396.                          ($name,$aliases,$addrtype,$length,@addrs) = gethost...
  2397.                          ($name,$aliases,$addrtype,$net) = getnet...
  2398.                          ($name,$aliases,$proto) = getproto...
  2399.                          ($name,$aliases,$port,$proto) = getserv...
  2400.  
  2401.           (If the entry doesn't exist you get a null list.)
  2402.  
  2403.           Within a scalar context, you get the name, unless the
  2404.           function was a lookup by name, in which case you get the
  2405.           other thing, whatever it is. (If the entry doesn't exist 
  2406.           you get the undefined value.)
  2407.  
  2408.           For example:
  2409.  
  2410.                          $uid = getpwnam
  2411.                          $name = getpwuid
  2412.                          $name = getpwent
  2413.                          $gid = getgrnam
  2414.                          $name = getgrgid
  2415.                          $name = getgrent
  2416.                          etc.
  2417.  
  2418.           The $members value returned by getgr... is a space
  2419.           separated list of the login names of the members of the
  2420.           group.
  2421.  
  2422.           For the gethost.\|.\|. functions, if the h_errno variable
  2423.           is supported in C, it will be returned to you via $? if
  2424.           the function call fails.  The @addrs value returned by a
  2425.           successful call is a list of the raw addresses returned by
  2426.           the corresponding system library call.  In the Internet
  2427.           domain, each address is four bytes long and you can unpack
  2428.           it by saying something like:
  2429.  
  2430.                          ($a,$b,$c,$d) = unpack('C4',$addr[0]);
  2431. æKY getsockname
  2432. æDT getsockname(SOCKET)
  2433. æC getsockname(SOCKET)
  2434.  
  2435.           Returns the packed sockaddr address of this end of the
  2436.           SOCKET connection.
  2437.  
  2438.                          # An internet sockaddr
  2439.                          $sockaddr = 'S n a4 x8';
  2440.                          $mysockaddr = getsockname(S);
  2441.                          ($family, $port, $myaddr) =
  2442.                                    unpack($sockaddr,$mysockaddr);
  2443. æKY getsockopt
  2444. æDT getsockopt(SOCKET,LEVEL,OPTNAME)
  2445. æC getsockopt(SOCKET,LEVEL,OPTNAME)
  2446.  
  2447.           Returns the socket option requested, or undefined if
  2448.           there is an error.
  2449. æKY gmtime
  2450. æDT gmtime(EXPR)
  2451. æC gmtime(EXPR)
  2452. gmtime EXPR
  2453.  
  2454.           Converts a time as returned by the time function to a 9-
  2455.           element array with the time analyzed for the Greenwich
  2456.           timezone.  Typically used as follows:
  2457.  
  2458.           ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
  2459.                                                             gmtime(time);
  2460.  
  2461.           All array elements are numeric, and come straight out of
  2462.           a struct tm.  In particular this means that $mon has the
  2463.           range 0..11 and $wday has the range 0..6.  If EXPR is
  2464.           omitted, does gmtime(time).
  2465. æKY goto
  2466. æDT goto LABEL
  2467. æC goto LABEL
  2468.  
  2469.           Finds the statement labeled with LABEL and resumes execu-
  2470.           tion there.  Currently you may only go to statements in
  2471.           the main body of the program that are not nested inside a
  2472.           do {} construct.  This statement is not implemented very
  2473.           efficiently, and is here only to make the sed-to-perl
  2474.           translator easier.  I may change its semantics at any
  2475.           time, consistent with support for translated sed scripts.
  2476.           Use it at your own risk.  Better yet, don't use it at
  2477.           all.
  2478. æKY grep
  2479. æDT grep(EXPR,LIST)
  2480. æC grep(EXPR,LIST)
  2481.  
  2482.           Evaluates EXPR for each element of LIST (locally setting
  2483.           $_ to each element) and returns the array value consist-
  2484.           ing of those elements for which the expression evaluated
  2485.           to true.  In a scalar context, returns the number of
  2486.           times the expression was true.
  2487.  
  2488.                          @foo = grep(!/^#/, @bar);    # weed out comments
  2489.  
  2490.           Note that, since $_ is a reference into the array value,
  2491.           it can be used to modify the elements of the array.
  2492.           While this is useful and supported, it can cause bizarre
  2493.           results if the LIST is not a named array.
  2494. æKY hex
  2495. æDT hex(EXPR)
  2496. æC hex(EXPR)
  2497. hex EXPR
  2498.  
  2499.           Returns the decimal value of EXPR interpreted as an hex
  2500.           string.  (To interpret strings that might start with 0 or
  2501.           0x see oct().) If EXPR is omitted, uses $_.
  2502. æKY index
  2503. æDT index(STR,SUBSTR,POSITION)
  2504. æC index(STR,SUBSTR,POSITION)
  2505. index(STR,SUBSTR)
  2506.  
  2507.           Returns the position of the first occurrence of SUBSTR in
  2508.           STR at or after POSITION.  If POSITION is omitted, starts
  2509.           searching from the beginning of the string.  The return
  2510.           value is based at 0, or whatever you've set the $[ vari-
  2511.           able to.  If the substring is not found, returns one less
  2512.           than the base, ordinarily -1.
  2513. æKY int
  2514. æDT int(EXPR)
  2515. æC int(EXPR)
  2516. int EXPR
  2517.  
  2518.           Returns the integer portion of EXPR.  If EXPR is omitted,
  2519.           uses $_.
  2520. æKY ioctl
  2521. æDT ioctl(FILEHANDLE,FUNCTION,SCALAR)
  2522. æC ioctl(FILEHANDLE,FUNCTION,SCALAR)
  2523.  
  2524.           Implements the ioctl(2) function.  You'll probably have
  2525.           to say
  2526.  
  2527.                          require "ioctl.ph"; # probably /usr/local/lib/perl/ioctl.ph
  2528.  
  2529.           first to get the correct function definitions.  If
  2530.           ioctl.ph doesn't exist or doesn't have the correct defin-
  2531.           itions you'll have to roll your own, based on your C
  2532.           header files such as <sys/ioctl.h>.  (There is a perl
  2533.           script called h2ph that comes with the perl kit which may
  2534.           help you in this.) SCALAR will be read and/or written
  2535.           depending on the FUNCTION--a pointer to the string value
  2536.           of SCALAR will be passed as the third argument of the
  2537.           actual ioctl call.  (If SCALAR has no string value but
  2538.           does have a numeric value, that value will be passed
  2539.           rather than a pointer to the string value.  To guarantee
  2540.           this to be true, add a 0 to the scalar before using it.)
  2541.           The pack() and unpack() functions are useful for manipu-
  2542.           lating the values of structures used by ioctl().  The
  2543.           following example sets the erase character to DEL.
  2544.  
  2545.                          require 'ioctl.ph';
  2546.                          $sgttyb_t = "ccccs";          # 4 chars and a short
  2547.                          if (ioctl(STDIN,$TIOCGETP,$sgttyb)) {
  2548.                               @ary = unpack($sgttyb_t,$sgttyb);
  2549.                               $ary[2] = 127;
  2550.                               $sgttyb = pack($sgttyb_t,@ary);
  2551.                               ioctl(STDIN,$TIOCSETP,$sgttyb)
  2552.                                    || die "Can't ioctl: $!";
  2553.                          }
  2554.  
  2555.           The return value of ioctl (and fcntl) is as follows:
  2556.  
  2557.                          if OS returns:           perl returns:
  2558.                          -1                       undefined value
  2559.                          0                        string "0 but true"
  2560.                          anything else            that number
  2561.  
  2562.           Thus perl returns true on success and false on failure,
  2563.           yet you can still easily determine the actual value
  2564.           returned by the operating system:
  2565.  
  2566.                          ($retval = ioctl(...)) || ($retval = -1);
  2567.                          printf "System returned %d\n", $retval;
  2568. æKY join
  2569. æDT join(EXPR,LIST)
  2570. æC join(EXPR,LIST)
  2571. join(EXPR,ARRAY)
  2572.  
  2573.           Joins the separate strings of LIST or ARRAY into a single
  2574.           string with fields separated by the value of EXPR, and
  2575.           returns the string.  Example:
  2576.  
  2577.           $_ = join(':',
  2578.                               $login,$passwd,$uid,$gid,$gcos,$home,$shell);
  2579.  
  2580.           See split.
  2581. æKY keys
  2582. æDT keys(ASSOC_ARRAY)
  2583. æC keys(ASSOC_ARRAY)
  2584. keys ASSOC_ARRAY
  2585.  
  2586.           Returns a normal array consisting of all the keys of the
  2587.           named associative array.  The keys are returned in an
  2588.           apparently random order, but it is the same order as
  2589.           either the values() or each() function produces (given
  2590.           that the associative array has not been modified).  Here
  2591.           is yet another way to print your environment:
  2592.  
  2593.                          @keys = keys %ENV;
  2594.                          @values = values %ENV;
  2595.                          while ($#keys >= 0) {
  2596.                               print pop(@keys), '=', pop(@values), "\n";
  2597.                          }
  2598.  
  2599.           or how about sorted by key:
  2600.  
  2601.                          foreach $key (sort(keys %ENV)) {
  2602.                               print $key, '=', $ENV{$key}, "\n";
  2603.                          }
  2604. æKY kill
  2605. æDT kill(LIST)
  2606. æC kill(LIST)
  2607. kill LIST
  2608.  
  2609.           Sends a signal to a list of processes.  The first element
  2610.           of the list must be the signal to send.  Returns the
  2611.           number of processes successfully signaled.
  2612.  
  2613.                          $cnt = kill 1, $child1, $child2;
  2614.                          kill 9, @goners;
  2615.  
  2616.           If the signal is negative, kills process groups instead
  2617.           of processes.  (On System V, a negative process number
  2618.           will also kill process groups, but that's not portable.)
  2619.           You may use a signal name in quotes.
  2620. æKY last
  2621. æDT last LABEL
  2622. æC last LABEL
  2623. last
  2624.           The last command is like the break statement in C (as
  2625.           used in loops); it immediately exits the loop in ques-
  2626.           tion.  If the LABEL is omitted, the command refers to the
  2627.           innermost enclosing loop.  The continue block, if any, is
  2628.           not executed:
  2629.  
  2630.                          line: while (<STDIN>) {
  2631.                               last line if /^$/;  # exit when done with header
  2632.                               ...
  2633.                          }
  2634. æKY length
  2635. æDT length(EXPR)
  2636. æC length(EXPR)
  2637. length EXPR
  2638.  
  2639.           Returns the length in characters of the value of EXPR.
  2640.           If EXPR is omitted, returns length of $_.
  2641. æKY link
  2642. æDT link(OLDFILE,NEWFILE)
  2643. æC link(OLDFILE,NEWFILE)
  2644.  
  2645.           Creates a new filename linked to the old filename.
  2646.           Returns 1 for success, 0 otherwise.
  2647. æKY listen
  2648. æDT listen(SOCKET,QUEUESIZE)
  2649. æC listen(SOCKET,QUEUESIZE)
  2650.  
  2651.           Does the same thing that the listen system call does.
  2652.           Returns true if it succeeded, false otherwise.  See exam-
  2653.           ple in section on Interprocess Communication.
  2654. æKY local
  2655. æDT local(LIST)
  2656. æC local(LIST)
  2657.  
  2658.           Declares the listed variables to be local to the enclos-
  2659.           ing block, subroutine, eval or "do".  All the listed ele-
  2660.           ments must be legal lvalues.  This operator works by sav-
  2661.           ing the current values of those variables in LIST on a
  2662.           hidden stack and restoring them upon exiting the block,
  2663.           subroutine or eval.  This means that called subroutines
  2664.           can also reference the local variable, but not the global
  2665.           one.  The LIST may be assigned to if desired, which
  2666.           allows you to initialize your local variables.  (If no
  2667.           initializer is given for a particular variable, it is
  2668.           created with an undefined value.) Commonly this is used
  2669.           to name the parameters to a subroutine.  Examples:
  2670.  
  2671.                          sub RANGEVAL {
  2672.                               local($min, $max, $thunk) = @_;
  2673.                               local($result) = '';
  2674.                               local($i);
  2675.  
  2676.                               # Presumably $thunk makes reference to $i
  2677.  
  2678.                               for ($i = $min; $i < $max; $i++) {
  2679.                                    $result .= eval $thunk;
  2680.                               }
  2681.  
  2682.                               $result;
  2683.                          }
  2684.  
  2685.                          if ($sw eq '-v') {
  2686.                          # init local array with global array
  2687.                          local(@ARGV) = @ARGV;
  2688.                          unshift(@ARGV,'echo');
  2689.                          system @ARGV;
  2690.                          }
  2691.                          # @ARGV restored
  2692.  
  2693.                          # temporarily add to digits associative array
  2694.                          if ($base12) {
  2695.                               # (NOTE: not claiming this is efficient!)
  2696.                               local(%digits) = (%digits,'t',10,'e',11);
  2697.                               do parse_num();
  2698.                          }
  2699.  
  2700.           Note that local() is a run-time command, and so gets exe-
  2701.           cuted every time through a loop, using up more stack
  2702.           storage each time until it's all released at once when
  2703.           the loop is exited.
  2704. æKY localtime
  2705. æDT localtime(EXPR)
  2706. æC localtime(EXPR)
  2707. localtime EXPR
  2708.  
  2709.           Converts a time as returned by the time function to a 9-
  2710.           element array with the time analyzed for the local
  2711.           timezone.  Typically used as follows:
  2712.  
  2713.           ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
  2714.                                                             localtime(time);
  2715.  
  2716.           All array elements are numeric, and come straight out of
  2717.           a struct tm.  In particular this means that $mon has the
  2718.           range 0..11 and $wday has the range 0..6.  If EXPR is
  2719.           omitted, does localtime(time).
  2720. æKY log
  2721. æDT log(EXPR)
  2722. æC log(EXPR)
  2723. log EXPR
  2724.  
  2725.           Returns logarithm (base e) of EXPR.  If EXPR is omitted,
  2726.           returns log of $_.
  2727. æKY lstat
  2728. æDT lstat(FILEHANDLE)
  2729. æC lstat(FILEHANDLE)
  2730. lstat FILEHANDLE
  2731. lstat(EXPR)
  2732. lstat SCALARVARIABLE
  2733.  
  2734.           Does the same thing as the stat() function, but stats a
  2735.           symbolic link instead of the file the symbolic link
  2736.           points to.  If symbolic links are unimplemented on your
  2737.           system, a normal stat is done.
  2738. æKY m
  2739. æDT m/PATTERN/gio
  2740. æC m/PATTERN/gio
  2741. /PATTERN/gio
  2742.  
  2743.           Searches a string for a pattern match, and returns true
  2744.           (1) or false ('').  If no string is specified via the =~
  2745.           or !~ operator, the $_ string is searched.  (The string
  2746.           specified with =~ need not be an lvalue--it may be the
  2747.           result of an expression evaluation, but remember the =~
  2748.           binds rather tightly.) See also the section on regular
  2749.           expressions.
  2750.  
  2751.           If / is the delimiter then the initial 'm' is optional.
  2752.           With the 'm' you can use any pair of non-alphanumeric
  2753.           characters as delimiters.  This is particularly useful
  2754.           for matching Unix path names that contain '/'.  If the
  2755.           final delimiter is followed by the optional letter 'i',
  2756.           the matching is done in a case-insensitive manner.  PAT-
  2757.           TERN may contain references to scalar variables, which
  2758.           will be interpolated (and the pattern recompiled) every
  2759.           time the pattern search is evaluated.  (Note that $) and
  2760.           $| may not be interpolated because they look like end-
  2761.           of-string tests.) If you want such a pattern to be com-
  2762.           piled only once, add an "o" after the trailing delimiter.
  2763.           This avoids expensive run-time recompilations, and is
  2764.           useful when the value you are interpolating won't change
  2765.           over the life of the script.  If the PATTERN evaluates to
  2766.           a null string, the most recent successful regular expres-
  2767.           sion is used instead.
  2768.  
  2769.           If used in a context that requires an array value, a pat-
  2770.           tern match returns an array consisting of the subexpres-
  2771.           sions matched by the parentheses in the pattern, i.e.
  2772.           ($1, $2, $3...).  It does NOT actually set $1, $2, etc.
  2773.           in this case, nor does it set $+, $`, $& or $'.  If the
  2774.           match fails, a null array is returned.  If the match
  2775.           succeeds, but there were no parentheses, an array value
  2776.           of (1) is returned.
  2777.  
  2778.           Examples:
  2779.  
  2780.                     open(tty, '/dev/tty');
  2781.                     <tty> =~ /^y/i && do foo();    # do foo if desired
  2782.  
  2783.                     if (/Version: *([0-9.]*)/) { $version = $1; }
  2784.  
  2785.                     next if m#^/usr/spool/uucp#;
  2786.  
  2787.                     # poor man's grep
  2788.                     $arg = shift;
  2789.                     while (<>) {
  2790.                          print if /$arg/o;    # compile only once
  2791.                     }
  2792.  
  2793.                     if (($F1, $F2, $Etc) = ($foo =~ /^(\S+)\s+(\S+)\s*(.*)/))
  2794.  
  2795.           This last example splits $foo into the first two words
  2796.           and the remainder of the line, and assigns those three
  2797.           fields to $F1, $F2 and $Etc.  The conditional is true if
  2798.           any variables were assigned, i.e. if the pattern matched.
  2799.  
  2800.           The g modifier specifies global pattern matching — that is,
  2801.           matching as many times as possible within the string.  How
  2802.           it behaves depends on the context.  In an array context, it
  2803.           returns a list of all the substrings matched by all the
  2804.           parentheses in the regular expression. If there are no
  2805.           parentheses, it returns a list of all the matched strings,
  2806.           as if there were parentheses around the whole pattern.  In
  2807.           a scalar context, it iterates through the string, returning
  2808.           TRUE each time it matches, and FALSE when it eventually runs
  2809.           out of matches.  (In other words, it remembers where it left
  2810.           off last time and restarts the search at that point.)  It
  2811.           presumes that you have not modified the string since the last
  2812.           match. Modifying the string between matches may result in
  2813.           undefined behavior. (You can actually get away with in-place
  2814.           modifications via substr() that do not change the length of
  2815.           the entire string.  In general, however, you should be using
  2816.           s///g for such modifications.)  Examples:
  2817.  
  2818.                     # array context
  2819.                     ($one,$five,$fifteen) = (\`uptime\` =~ /(\ed+\e.\ed+)/g);
  2820.  
  2821.                     # scalar context
  2822.                     $/ = ""; $* = 1;
  2823.                     while ($paragraph = <>) {
  2824.                         while ($paragraph =~ /[a-z][\'")]*[.!?]+[\'")]*\es/g) {
  2825.                             $sentences++;
  2826.                         }
  2827.                     }
  2828.                     print "$sentences\en";
  2829.  
  2830. ?PATTERN?
  2831.  
  2832.           This is just like the /pattern/ search, except that it
  2833.           matches only once between calls to the reset operator.
  2834.           This is a useful optimization when you only want to see
  2835.           the first occurrence of something in each file of a set
  2836.           of files, for instance.  Only ?? patterns local to the
  2837.           current package are reset.
  2838. æKY mkdir
  2839. æDT mkdir(FILENAME,MODE)
  2840. æC mkdir(FILENAME,MODE)
  2841.  
  2842.           Creates the directory specified by FILENAME, with permis-
  2843.           sions specified by MODE (as modified by umask).  If it
  2844.           succeeds it returns 1, otherwise it returns 0 and sets $!
  2845.           (errno).
  2846. æKY msgctl
  2847. æDT msgctl(ID,CMD,ARG)
  2848. æC msgctl(ID,CMD,ARG)
  2849.  
  2850.           Calls the System V IPC function msgctl.  If CMD is
  2851.           &IPC_STAT, then ARG must be a variable which will hold
  2852.           the returned msqid_ds structure.  Returns like ioctl: the
  2853.           undefined value for error, "0 but true" for zero, or the
  2854.           actual return value otherwise.
  2855. æKY msgget
  2856. æDT msgget(KEY,FLAGS)
  2857. æC msgget(KEY,FLAGS)
  2858.  
  2859.           Calls the System V IPC function msgget.  Returns the mes-
  2860.           sage queue id, or the undefined value if there is an
  2861.           error.
  2862. æKY msgsnd
  2863. æDT msgsnd(ID,MSG,FLAGS)
  2864. æC msgsnd(ID,MSG,FLAGS)
  2865.  
  2866.           Calls the System V IPC function msgsnd to send the mes-
  2867.           sage MSG to the message queue ID.  MSG must begin with
  2868.           the long integer message type, which may be created with
  2869.           pack("L", $type).  Returns true if successful, or false
  2870.           if there is an error.
  2871. æKY msgrcv
  2872. æDT msgrcv(ID,VAR,SIZE,TYPE,FLAGS)
  2873. æC msgrcv(ID,VAR,SIZE,TYPE,FLAGS)
  2874.  
  2875.           Calls the System V IPC function msgrcv to receive a mes-
  2876.           sage from message queue ID into variable VAR with a max-
  2877.           imum message size of SIZE.  Note that if a message is
  2878.           received, the message type will be the first thing in
  2879.           VAR, and the maximum length of VAR is SIZE plus the size
  2880.           of the message type.  Returns true if successful, or
  2881.           false if there is an error.
  2882. æKY next
  2883. æDT next LABEL
  2884. æC next LABEL
  2885. next
  2886.  
  2887.           The next command is like the continue statement in C; it
  2888.           starts the next iteration of the loop:
  2889.  
  2890.                          line: while (<STDIN>) {
  2891.                               next line if /^#/;  # discard comments
  2892.                               ...
  2893.                          }
  2894.  
  2895.           Note that if there were a continue block on the above, it
  2896.           would get executed even on discarded lines.  If the LABEL
  2897.           is omitted, the command refers to the innermost enclosing
  2898.           loop.
  2899. æKY oct
  2900. æDT oct(EXPR)
  2901. æC oct(EXPR)
  2902. oct EXPR
  2903.  
  2904.           Returns the decimal value of EXPR interpreted as an octal
  2905.           string.  (If EXPR happens to start off with 0x, inter-
  2906.           prets it as a hex string instead.) The following will
  2907.           handle decimal, octal and hex in the standard notation:
  2908.  
  2909.                          $val = oct($val) if $val =~ /^0/;
  2910.  
  2911.           If EXPR is omitted, uses $_.
  2912. æKY open
  2913. æDT open(FILEHANDLE,EXPR)
  2914. æC open(FILEHANDLE,EXPR)
  2915. open(FILEHANDLE)
  2916. open FILEHANDLE
  2917.  
  2918.           Opens the file whose filename is given by EXPR, and asso-
  2919.           ciates it with FILEHANDLE.  If FILEHANDLE is an expres-
  2920.           sion, its value is used as the name of the real filehan-
  2921.           dle wanted.  If EXPR is omitted, the scalar variable of
  2922.           the same name as the FILEHANDLE contains the filename.
  2923.           If the filename begins with "<" or nothing, the file is
  2924.           opened for input.  If the filename begins with ">", the
  2925.           file is opened for output.  If the filename begins with
  2926.           ">>", the file is opened for appending.  (You can put a
  2927.           '+' in front of the '>' or '<' to indicate that you want
  2928.           both read and write access to the file.) If the filename
  2929.           begins with "|", the filename is interpreted as a command
  2930.           to which output is to be piped, and if the filename ends
  2931.           with a "|", the filename is interpreted as command which
  2932.           pipes input to us.  (You may not have a command that
  2933.           pipes both in and out.) Opening '-' opens STDIN and open-
  2934.           ing '>-' opens STDOUT.  Open returns non-zero upon suc-
  2935.           cess, the undefined value otherwise.  If the open
  2936.           involved a pipe, the return value happens to be the pid
  2937.           of the subprocess.  Examples:
  2938.  
  2939.                          $article = 100;
  2940.                          open article || die "Can't find article $article: $!\n";
  2941.                          while (<article>) {...
  2942.  
  2943.                          open(LOG, '>>/usr/spool/news/twitlog');
  2944.                                                        # (log is reserved)
  2945.  
  2946.                          open(article, "caesar <$article |");
  2947.                                                        # decrypt article
  2948.  
  2949.                          open(extract, "|sort >/tmp/Tmp$$");
  2950.                                                        # $$ is our process#
  2951.  
  2952.                          # process argument list of files along with any includes
  2953.  
  2954.                          foreach $file (@ARGV) {
  2955.                               do process($file, 'fh00');    # no pun intended
  2956.                          }
  2957.  
  2958.                          sub process {
  2959.                               local($filename, $input) = @_;
  2960.                               $input++;      # this is a string increment
  2961.                               unless (open($input, $filename)) {
  2962.                                    print STDERR "Can't open $filename: $!\n";
  2963.                                    return;
  2964.                               }
  2965.                               while (<$input>) {       # note use of indirection
  2966.                                    if (/^#include "(.*)"/) {
  2967.                                                   do process($1, $input);
  2968.                                                   next;
  2969.                                    }
  2970.                                    ...       # whatever
  2971.                               }
  2972.                          }
  2973.  
  2974.           You may also, in the Bourne shell tradition, specify an
  2975.           EXPR beginning with ">&", in which case the rest of the
  2976.           string is interpreted as the name of a filehandle (or
  2977.           file descriptor, if numeric) which is to be duped and
  2978.           opened.  You may use & after >, >>, <, +>, +>> and +<.
  2979.           The mode you specify should match the mode of the origi-
  2980.           nal filehandle.  Here is a script that saves, redirects,
  2981.           and restores STDOUT and STDERR:
  2982.  
  2983.                          #!/usr/bin/perl
  2984.                          open(SAVEOUT, ">&STDOUT");
  2985.                          open(SAVEERR, ">&STDERR");
  2986.  
  2987.                          open(STDOUT, ">foo.out") || die "Can't redirect stdout";
  2988.                          open(STDERR, ">&STDOUT") || die "Can't dup stdout";
  2989.  
  2990.                          select(STDERR); $| = 1;       # make unbuffered
  2991.                          select(STDOUT); $| = 1;       # make unbuffered
  2992.  
  2993.                          print STDOUT "stdout 1\n";    # this works for
  2994.                          print STDERR "stderr 1\n";    # subprocesses too
  2995.  
  2996.                          close(STDOUT);
  2997.                          close(STDERR);
  2998.  
  2999.                          open(STDOUT, ">&SAVEOUT");
  3000.                          open(STDERR, ">&SAVEERR");
  3001.  
  3002.                          print STDOUT "stdout 2\n";
  3003.                          print STDERR "stderr 2\n";
  3004.  
  3005.           If you open a pipe on the command "-", i.e. either "|-"
  3006.           or "-|", then there is an implicit fork done, and the
  3007.           return value of open is the pid of the child within the
  3008.           parent process, and 0 within the child process.  (Use
  3009.           defined($pid) to determine if the open was successful.)
  3010.           The filehandle behaves normally for the parent, but i/o
  3011.           to that filehandle is piped from/to the STDOUT/STDIN of
  3012.           the child process.  In the child process the filehandle
  3013.           isn't opened--i/o happens from/to the new STDOUT or
  3014.           STDIN.  Typically this is used like the normal piped open
  3015.           when you want to exercise more control over just how the
  3016.           pipe command gets executed, such as when you are running
  3017.           setuid, and don't want to have to scan shell commands for
  3018.           metacharacters.  The following pairs are more or less
  3019.           equivalent:
  3020.  
  3021.                          open(FOO, "|tr '[a-z]' '[A-Z]'");
  3022.                          open(FOO, "|-") || exec 'tr', '[a-z]', '[A-Z]';
  3023.  
  3024.                          open(FOO, "cat -n '$file'|");
  3025.                          open(FOO, "-|") || exec 'cat', '-n', $file;
  3026.  
  3027.           Explicitly closing any piped filehandle causes the parent
  3028.           process to wait for the child to finish, and returns the
  3029.           status value in $?.  Note: on any operation which may do
  3030.           a fork, unflushed buffers remain unflushed in both
  3031.           processes, which means you may need to set $| to avoid
  3032.           duplicate output.
  3033.  
  3034.           The filename that is passed to open will have leading and
  3035.           trailing whitespace deleted.  In order to open a file
  3036.           with arbitrary weird characters in it, it's necessary to
  3037.           protect any leading and trailing whitespace thusly:
  3038.  
  3039.                               $file =~ s#^(\s)#./$1#;
  3040.                               open(FOO, "< $file\0");
  3041. æKY opendir
  3042. æDT opendir(DIRHANDLE,EXPR)
  3043. æC opendir(DIRHANDLE,EXPR)
  3044.  
  3045.           Opens a directory named EXPR for processing by readdir(),
  3046.           telldir(), seekdir(), rewinddir() and closedir().
  3047.           Returns true if successful.  DIRHANDLEs have their own
  3048.           namespace separate from FILEHANDLEs.
  3049. æKY ord
  3050. æDT ord(EXPR)
  3051. æC ord(EXPR)
  3052. ord EXPR
  3053.  
  3054.           Returns the numeric ascii value of the first character of
  3055.           EXPR.  If EXPR is omitted, uses $_.
  3056. æKY pack
  3057. æDT pack(TEMPLATE,LIST)
  3058. æC pack(TEMPLATE,LIST)
  3059.  
  3060.           Takes an array or list of values and packs it into a
  3061.           binary structure, returning the string containing the
  3062.           structure.  The TEMPLATE is a sequence of characters that
  3063.           give the order and type of values, as follows:
  3064.  
  3065.                          A    An ascii string, will be space padded.
  3066.                          a    An ascii string, will be null padded.
  3067.                          c    A signed char value.
  3068.                          C    An unsigned char value.
  3069.                          s    A signed short value.
  3070.                          S    An unsigned short value.
  3071.                          i    A signed integer value.
  3072.                          I    An unsigned integer value.
  3073.                          l    A signed long value.
  3074.                          L    An unsigned long value.
  3075.                          n    A short in "network" order.
  3076.                          N    A long in "network" order.
  3077.                          v      A short in VAX (little-endian) order.
  3078.                          V      A long in VAX (little-endian) order.
  3079.                          f    A single-precision float in the native format.
  3080.                          d    A double-precision float in the native format.
  3081.                          p    A pointer to a string.
  3082.                          x    A null byte.
  3083.                          X    Back up a byte.
  3084.                          @    Null fill to absolute position.
  3085.                          u    A uuencoded string.
  3086.                          b    A bit string (ascending bit order, like vec()).
  3087.                          B    A bit string (descending bit order).
  3088.                          h    A hex string (low nybble first).
  3089.                          H    A hex string (high nybble first).
  3090.  
  3091.           Each letter may optionally be followed by a number which
  3092.           gives a repeat count.  With all types except "a", "A",
  3093.           "b", "B", "h" and "H", the pack function will gobble up
  3094.           that many values from the LIST.  A * for the repeat count
  3095.           means to use however many items are left.  The "a" and
  3096.           "A" types gobble just one value, but pack it as a string
  3097.           of length count, padding with nulls or spaces as neces-
  3098.           sary.  (When unpacking, "A" strips trailing spaces and
  3099.           nulls, but "a" does not.) Likewise, the "b" and "B"
  3100.           fields pack a string that many bits long.  The "h" and
  3101.           "H" fields pack a string that many nybbles long.  Real
  3102.           numbers (floats and doubles) are in the native machine
  3103.           format only; due to the multiplicity of floating formats
  3104.           around, and the lack of a standard "network" representa-
  3105.           tion, no facility for interchange has been made.  This
  3106.           means that packed floating point data written on one
  3107.           machine may not be readable on another - even if both use
  3108.           IEEE floating point arithmetic (as the endian-ness of the
  3109.           memory representation is not part of the IEEE spec).
  3110.           Note that perl uses doubles internally for all numeric
  3111.           calculation, and converting from double -> float -> dou-
  3112.           ble will lose precision (i.e. unpack("f", pack("f",
  3113.           $foo)) will not in general equal $foo).
  3114.           Examples:
  3115.  
  3116.                          $foo = pack("cccc",65,66,67,68);
  3117.                          # foo eq "ABCD"
  3118.                          $foo = pack("c4",65,66,67,68);
  3119.                          # same thing
  3120.  
  3121.                          $foo = pack("ccxxcc",65,66,67,68);
  3122.                          # foo eq "AB\0\0CD"
  3123.  
  3124.                          $foo = pack("s2",1,2);
  3125.                          # "\1\0\2\0" on little-endian
  3126.                          # "\0\1\0\2" on big-endian
  3127.  
  3128.                          $foo = pack("a4","abcd","x","y","z");
  3129.                          # "abcd"
  3130.  
  3131.                          $foo = pack("aaaa","abcd","x","y","z");
  3132.                          # "axyz"
  3133.  
  3134.                          $foo = pack("a14","abcdefg");
  3135.                          # "abcdefg\0\0\0\0\0\0\0"
  3136.  
  3137.                          $foo = pack("i9pl", gmtime);
  3138.                          # a real struct tm (on my system anyway)
  3139.  
  3140.                          sub bintodec {
  3141.                          unpack("N", pack("B32", substr("0" x 32 . shift, -32)));
  3142.                          }
  3143.           The same template may generally also be used in the
  3144.           unpack function.
  3145. æKY pipe
  3146. æDT pipe(READHANDLE,WRITEHANDLE)
  3147. æC pipe(READHANDLE,WRITEHANDLE)
  3148.  
  3149.           Opens a pair of connected pipes like the corresponding
  3150.           system call.  Note that if you set up a loop of piped
  3151.           processes, deadlock can occur unless you are very care-
  3152.           ful.  In addition, note that perl's pipes use stdio
  3153.           buffering, so you may need to set $| to flush your WRI-
  3154.           TEHANDLE after each command, depending on the applica-
  3155.           tion.  [Requires version 3.0 patchlevel 9.]
  3156. æKY pop
  3157. æDT pop(ARRAY)
  3158. æC pop(ARRAY)
  3159. pop ARRAY
  3160.  
  3161.           Pops and returns the last value of the array, shortening
  3162.           the array by 1.  Has the same effect as
  3163.  
  3164.                          $tmp = $ARRAY[$#ARRAY--];
  3165.  
  3166.           If there are no elements in the array, returns the unde-
  3167.           fined value.
  3168. æKY print
  3169. æDT print(FILEHANDLE LIST)
  3170. æC print(FILEHANDLE LIST)
  3171. print(LIST)
  3172. print FILEHANDLE LIST
  3173. print LIST
  3174. print
  3175.           Prints a string or a comma-separated list of strings.
  3176.           Returns non-zero if successful.  FILEHANDLE may be a
  3177.           scalar variable name, in which case the variable contains
  3178.           the name of the filehandle, thus introducing one level of
  3179.           indirection.  (NOTE: If FILEHANDLE is a variable and the
  3180.           next token is a term, it may be misinterpreted as an
  3181.           operator unless you interpose a + or put parens around
  3182.           the arguments.) If FILEHANDLE is omitted, prints by
  3183.           default to standard output (or to the last selected out-
  3184.           put channel--see select()).  If LIST is also omitted,
  3185.           prints $_ to STDOUT.  To set the default output channel
  3186.           to something other than STDOUT use the select operation.
  3187.           Note that, because print takes a LIST, anything in the
  3188.           LIST is evaluated in an array context, and any subroutine
  3189.           that you call will have one or more of its expressions
  3190.           evaluated in an array context.  Also be careful not to
  3191.           follow the print keyword with a left parenthesis unless
  3192.           you want the corresponding right parenthesis to terminate
  3193.           the arguments to the print--interpose a + or put parens
  3194.           around all the arguments.
  3195. æKY printf
  3196. æDT printf(FILEHANDLE LIST)
  3197. æC printf(FILEHANDLE LIST)
  3198. printf(LIST)
  3199. printf FILEHANDLE LIST
  3200. printf LIST
  3201.  
  3202.           Equivalent to a "print FILEHANDLE sprintf(LIST)".
  3203. æKY push
  3204. æDT push(ARRAY,LIST)
  3205. æC push(ARRAY,LIST)
  3206.  
  3207.           Treats ARRAY (@ is optional) as a stack, and pushes the
  3208.           values of LIST onto the end of ARRAY.  The length of
  3209.           ARRAY increases by the length of LIST.  Has the same
  3210.           effect as
  3211.  
  3212.                     for $value (LIST) {
  3213.                          $ARRAY[++$#ARRAY] = $value;
  3214.                     }
  3215.  
  3216.           but is more efficient.
  3217. æKY q
  3218. æDT q/STRING/
  3219. æC q/STRING/
  3220. qq/STRING/
  3221. qx/STRING/
  3222.  
  3223.           These are not really functions, but simply syntactic
  3224.           sugar to let you avoid putting too many backslashes into
  3225.           quoted strings.  The q operator is a generalized single
  3226.           quote, and the qq operator a generalized double quote.
  3227.           The qx operator is a generalized backquote.  Any non-
  3228.           alphanumeric delimiter can be used in place of /, includ-
  3229.           ing newline.  If the delimiter is an opening bracket or
  3230.           parenthesis, the final delimiter will be the correspond-
  3231.           ing closing bracket or parenthesis.  (Embedded
  3232.           occurrences of the closing bracket need to be backslashed
  3233.           as usual.) Examples:
  3234.  
  3235.                          $foo = q!I said, "You said, 'She said it.'"!;
  3236.                          $bar = q('This is it.');
  3237.                          $today = qx{ date };
  3238.                          $_ .= qq
  3239.           *** The previous line contains the naughty word "$&".\n
  3240.                               if /(ibm|apple|awk)/;      # :-)
  3241. æKY rand
  3242. æDT rand(EXPR)
  3243. æC rand(EXPR)
  3244. rand EXPR
  3245. rand
  3246.           Returns a random fractional number between 0 and the
  3247.           value of EXPR.  (EXPR should be positive.) If EXPR is
  3248.           omitted, returns a value between 0 and 1.  See also
  3249.           srand().
  3250. æKY read
  3251. æDT read(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  3252. æC read(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  3253. read(FILEHANDLE,SCALAR,LENGTH)
  3254.  
  3255.           Attempts to read LENGTH bytes of data into variable
  3256.           SCALAR from the specified FILEHANDLE.  Returns the number
  3257.           of bytes actually read, or undef if there was an error.
  3258.           SCALAR will be grown or shrunk to the length actually
  3259.           read.  An OFFSET may be specified to place the read data
  3260.           at some other place than the beginning of the string.
  3261.           This call is actually implemented in terms of stdio's
  3262.           fread call.  To get a true read system call, see sysread.
  3263. æKY readdir
  3264. æDT readdir(DIRHANDLE)
  3265. æC readdir(DIRHANDLE)
  3266. readdir DIRHANDLE
  3267.  
  3268.           Returns the next directory entry for a directory opened
  3269.           by opendir().  If used in an array context, returns all
  3270.           the rest of the entries in the directory.  If there are
  3271.           no more entries, returns an undefined value in a scalar
  3272.           context or a null list in an array context.
  3273. æKY readlink
  3274. æDT readlink(EXPR)
  3275. æC readlink(EXPR)
  3276. readlink EXPR
  3277.  
  3278.           Returns the value of a symbolic link, if symbolic links
  3279.           are implemented.  If not, gives a fatal error.  If there
  3280.           is some system error, returns the undefined value and
  3281.           sets $! (errno).  If EXPR is omitted, uses $_.
  3282. æKY recv
  3283. æDT recv(SOCKET,SCALAR,LEN,FLAGS)
  3284. æC recv(SOCKET,SCALAR,LEN,FLAGS)
  3285.  
  3286.           Receives a message on a socket.  Attempts to receive
  3287.           LENGTH bytes of data into variable SCALAR from the speci-
  3288.           fied SOCKET filehandle.  Returns the address of the
  3289.           sender, or the undefined value if there's an error.
  3290.           SCALAR will be grown or shrunk to the length actually
  3291.           read.  Takes the same flags as the system call of the
  3292.           same name.
  3293. æKY redo
  3294. æDT redo LABEL
  3295. æC redo LABEL
  3296. redo
  3297.  
  3298.           The redo command restarts the loop block without evaluat-
  3299.           ing the conditional again.  The continue block, if any,
  3300.           is not executed.  If the LABEL is omitted, the command
  3301.           refers to the innermost enclosing loop.  This command is
  3302.           normally used by programs that want to lie to themselves
  3303.           about what was just input:
  3304.  
  3305.                          # a simpleminded Pascal comment stripper
  3306.                          # (warning: assumes no { or } in strings)
  3307.                          line: while (<STDIN>) {
  3308.                               while (s|({.*}.*){.*}|$1 |) {}
  3309.                               s|{.*}| |;
  3310.                               if (s|{.*| |) {
  3311.                                    $front = $_;
  3312.                                    while (<STDIN>) {
  3313.                                                   if (/}/) {     # end of comment?
  3314.                                                        s|^|$front{|;
  3315.                                                        redo line;
  3316.                                                   }
  3317.                                    }
  3318.                               }
  3319.                               print;
  3320.                          }
  3321. æKY rename
  3322. æDT rename(OLDNAME,NEWNAME)
  3323. æC rename(OLDNAME,NEWNAME)
  3324.  
  3325.           Changes the name of a file.  Returns 1 for success, 0
  3326.           otherwise.  Will not work across filesystem boundaries.
  3327. æKY require
  3328. æDT require(EXPR)
  3329. æC require(EXPR)
  3330. require EXPR
  3331. require
  3332.  
  3333.           Includes the library file specified by EXPR, or by $_ if
  3334.           EXPR is not supplied.  Has semantics similar to the fol-
  3335.           lowing subroutine:
  3336.  
  3337.                          sub require {
  3338.                          local($filename) = @_;
  3339.                          return 1 if $INC{$filename};
  3340.                          local($realfilename,$result);
  3341.                          ITER: {
  3342.                               foreach $prefix (@INC) {
  3343.                                         $realfilename = "$prefix/$filename";
  3344.                                         if (-f $realfilename) {
  3345.                                    $result = do $realfilename;
  3346.                                    last ITER;
  3347.                                         }
  3348.                               }
  3349.                               die "Can't find $filename in \@INC";
  3350.                          }
  3351.                          die $@ if $@;
  3352.                          die "$filename did not return true value" unless $result;
  3353.                          $INC{$filename} = $realfilename;
  3354.                          $result;
  3355.                          }
  3356.  
  3357.           Note that the file will not be included twice under the
  3358.           same specified name.
  3359.  
  3360.           The file must return true as the last statement to
  3361.           indicate successful execution of any initialization code,
  3362.           so it's customary to end such a file with 1; unless you're
  3363.           sure it'll return true otherwise.
  3364. æKY reset
  3365. æDT reset(EXPR)
  3366. æC reset(EXPR)
  3367. reset EXPR
  3368. reset
  3369.  
  3370.           Generally used in a continue block at the end of a loop
  3371.           to clear variables and reset ?? searches so that they
  3372.           work again.  The expression is interpreted as a list of
  3373.           single characters (hyphens allowed for ranges).  All
  3374.           variables and arrays beginning with one of those letters
  3375.           are reset to their pristine state.  If the expression is
  3376.           omitted, one-match searches (?pattern?) are reset to
  3377.           match again.  Only resets variables or searches in the
  3378.           current package.  Always returns 1.  Examples:
  3379.  
  3380.                     reset 'X';      # reset all X variables
  3381.                     reset 'a-z';    # reset lower case variables
  3382.                     reset;          # just reset ?? searches
  3383.  
  3384.           Note: resetting "A-Z" is not recommended since you'll
  3385.           wipe out your ARGV and ENV arrays.
  3386.  
  3387.           The use of reset on dbm associative arrays does not
  3388.           change the dbm file.  (It does, however, flush any
  3389.           entries cached by perl, which may be useful if you are
  3390.           sharing the dbm file.  Then again, maybe not.)
  3391. æKY return
  3392. æDT return LIST
  3393. æC return LIST
  3394.  
  3395.           Returns from a subroutine with the value specified.
  3396.           (Note that a subroutine can automatically return the
  3397.           value of the last expression evaluated.  That's the pre-
  3398.           ferred method--use of an explicit return is a bit
  3399.           slower.)
  3400. æKY reverse
  3401. æDT reverse(LIST)
  3402. æC reverse(LIST)
  3403. reverse LIST
  3404.  
  3405.           In an array context, returns an array value consisting of
  3406.           the elements of LIST in the opposite order.  In a scalar
  3407.           context, returns a string value consisting of the bytes
  3408.           of the first element of LIST in the opposite order.
  3409. æKY rewinddir
  3410. æDT rewinddir(DIRHANDLE)
  3411. æC rewinddir(DIRHANDLE)
  3412. rewinddir DIRHANDLE
  3413.  
  3414.           Sets the current position to the beginning of the direc-
  3415.           tory for the readdir() routine on DIRHANDLE.
  3416. æKY rindex
  3417. æDT rindex(STR,SUBSTR,POSITION)
  3418. æC rindex(STR,SUBSTR,POSITION)
  3419. rindex(STR,SUBSTR)
  3420.  
  3421.           Works just like index except that it returns the position
  3422.           of the LAST occurrence of SUBSTR in STR.  If POSITION is
  3423.           specified, returns the last occurrence at or before that
  3424.           position.
  3425. æKY rmdir
  3426. æDT rmdir(FILENAME)
  3427. æC rmdir(FILENAME)
  3428. rmdir FILENAME
  3429.  
  3430.           Deletes the directory specified by FILENAME if it is
  3431.           empty.  If it succeeds it returns 1, otherwise it returns
  3432.           0 and sets $! (errno).  If FILENAME is omitted, uses $_.
  3433. æKY s
  3434. æDT s/PATTERN/REPLACEMENT/gieo
  3435. æC s/PATTERN/REPLACEMENT/gieo
  3436.  
  3437.           Searches a string for a pattern, and if found, replaces
  3438.           that pattern with the replacement text and returns the
  3439.           number of substitutions made.  Otherwise it returns false
  3440.           (0).  The "g" is optional, and if present, indicates that
  3441.           all occurrences of the pattern are to be replaced.  The
  3442.           "i" is also optional, and if present, indicates that
  3443.           matching is to be done in a case-insensitive manner.  The
  3444.           "e" is likewise optional, and if present, indicates that
  3445.           the replacement string is to be evaluated as an expres-
  3446.           sion rather than just as a double-quoted string.  Any
  3447.           non-alphanumeric delimiter may replace the slashes; if
  3448.           single quotes are used, no interpretation is done on the
  3449.           replacement string (the e modifier overrides this, how-
  3450.           ever); if backquotes are used, the replacement string is
  3451.           a command to execute whose output will be used as the
  3452.           actual replacement text.  If the PATTERN is delimited by
  3453.           bracketing quotes, the REPLACEMENT has its own pair of
  3454.           quotes, which may or may not be bracketing quotes, e.g.
  3455.           s(foo)(bar) or s<foo>/bar/.  If no string is specified via
  3456.           the =~ or !~ operator, the $_ string is searched and
  3457.           modified.  (The string specified with =~ must be a scalar
  3458.           variable, an array element, or an assignment to one of
  3459.           those, i.e. an lvalue.) If the pattern contains a $ that
  3460.           looks like a variable rather than an end-of-string test,
  3461.           the variable will be interpolated into the pattern at
  3462.           run-time.  If you only want the pattern compiled once the
  3463.           first time the variable is interpolated, add an "o" at
  3464.           the end.  If the PATTERN evaluates to a null string, the
  3465.           most recent successful regular expression is used
  3466.           instead.  See also the section on regular expressions.
  3467.           Examples:
  3468.  
  3469.                     s/\bgreen\b/mauve/g;      # don't change wintergreen
  3470.  
  3471.                     $path =~ s|/usr/bin|/usr/local/bin|;
  3472.  
  3473.                     s/Login: $foo/Login: $bar/; # run-time pattern
  3474.  
  3475.                     ($foo = $bar) =~ s/bar/foo/;
  3476.  
  3477.                     $_ = 'abc123xyz';
  3478.                     s/\d+/$&*2/e;        # yields 'abc246xyz'
  3479.                     s/\d+/sprintf("%5d",$&)/e;     # yields 'abc  246xyz'
  3480.                     s/\w/$& x 2/eg;      # yields 'aabbcc  224466xxyyzz'
  3481.  
  3482.                     s/([^ ]*) *([^ ]*)/$2 $1/;     # reverse 1st two fields
  3483.  
  3484.           (Note the use of $ instead of \ in the last example.  See
  3485.           section on regular expressions.)
  3486. æKY scalar
  3487. æDT scalar(EXPR)
  3488. æC scalar(EXPR)
  3489.  
  3490.           Forces EXPR to be interpreted in a scalar context and
  3491.           returns the value of EXPR.
  3492. æKY seek
  3493. æDT seek(FILEHANDLE,POSITION,WHENCE)
  3494. æC seek(FILEHANDLE,POSITION,WHENCE)
  3495.  
  3496.           Randomly positions the file pointer for FILEHANDLE, just
  3497.           like the fseek() call of stdio.  FILEHANDLE may be an
  3498.           expression whose value gives the name of the filehandle.
  3499.           Returns 1 upon success, 0 otherwise.
  3500. æKY seekdir
  3501. æDT seekdir(DIRHANDLE,POS)
  3502. æC seekdir(DIRHANDLE,POS)
  3503.  
  3504.           Sets the current position for the readdir() routine on
  3505.           DIRHANDLE.  POS must be a value returned by telldir().
  3506.           Has the same caveats about possible directory compaction
  3507.           as the corresponding system library routine.
  3508. æKY select
  3509. æDT select(FILEHANDLE)
  3510. æC select(FILEHANDLE)
  3511. select
  3512.           Returns the currently selected filehandle.  Sets the
  3513.           current default filehandle for output, if FILEHANDLE is
  3514.           supplied.  This has two effects: first, a write or a
  3515.           print without a filehandle will default to this FILEHAN-
  3516.           DLE.  Second, references to variables related to output
  3517.           will refer to this output channel.  For example, if you
  3518.           have to set the top of form format for more than one out-
  3519.           put channel, you might do the following:
  3520.  
  3521.                          select(REPORT1);
  3522.                          $^ = 'report1_top';
  3523.                          select(REPORT2);
  3524.                          $^ = 'report2_top';
  3525.  
  3526.           FILEHANDLE may be an expression whose value gives the
  3527.           name of the actual filehandle.  Thus:
  3528.  
  3529.                          $oldfh = select(STDERR); $| = 1; select($oldfh);
  3530.  
  3531. select(RBITS,WBITS,EBITS,TIMEOUT)
  3532.  
  3533.           This calls the select system call with the bitmasks
  3534.           specified, which can be constructed using fileno() and
  3535.           vec(), along these lines:
  3536.  
  3537.                          $rin = $win = $ein = '';
  3538.                          vec($rin,fileno(STDIN),1) = 1;
  3539.                          vec($win,fileno(STDOUT),1) = 1;
  3540.                          $ein = $rin | $win;
  3541.  
  3542.           If you want to select on many filehandles you might wish
  3543.           to write a subroutine:
  3544.  
  3545.                          sub fhbits {
  3546.                          local(@fhlist) = split(' ',$_[0]);
  3547.                          local($bits);
  3548.                          for (@fhlist) {
  3549.                               vec($bits,fileno($_),1) = 1;
  3550.                          }
  3551.                          $bits;
  3552.                          }
  3553.                          $rin = &fhbits('STDIN TTY SOCK');
  3554.  
  3555.           The usual idiom is:
  3556.  
  3557.                          ($nfound,$timeleft) =
  3558.                          select($rout=$rin, $wout=$win, $eout=$ein, $timeout);
  3559.  
  3560.           or to block until something becomes ready:
  3561.  
  3562.                          $nfound = select($rout=$rin, $wout=$win,
  3563.                                                   $eout=$ein, undef);
  3564.  
  3565.           Any of the bitmasks can also be undef.  The timeout, if
  3566.           specified, is in seconds, which may be fractional.  NOTE:
  3567.           not all implementations are capable of returning the
  3568.           $timeleft.  If not, they always return $timeleft equal to
  3569.           the supplied $timeout.
  3570. æKY semctl
  3571. æDT semctl(ID,SEMNUM,CMD,ARG)
  3572. æC semctl(ID,SEMNUM,CMD,ARG)
  3573.  
  3574.           Calls the System V IPC function semctl.  If CMD is
  3575.           &IPC_STAT or &GETALL, then ARG must be a variable which
  3576.           will hold the returned semid_ds structure or semaphore
  3577.           value array.  Returns like ioctl: the undefined value for
  3578.           error, "0 but true" for zero, or the actual return value
  3579.           otherwise.
  3580. æKY semget
  3581. æDT semget(KEY,NSEMS,SIZE,FLAGS)
  3582. æC semget(KEY,NSEMS,SIZE,FLAGS)
  3583.  
  3584.           Calls the System V IPC function semget.  Returns the
  3585.           semaphore id, or the undefined value if there is an
  3586.           error.
  3587. æKY semop
  3588. æDT semop(KEY,OPSTRING)
  3589. æC semop(KEY,OPSTRING)
  3590.  
  3591.           Calls the System V IPC function semop to perform sema-
  3592.           phore operations such as signaling and waiting.  OPSTRING
  3593.           must be a packed array of semop structures.  Each semop
  3594.           structure can be generated with 'pack("sss", $semnum,
  3595.           $semop, $semflag)'.  The number of semaphore operations
  3596.           is implied by the length of OPSTRING.  Returns true if
  3597.           successful, or false if there is an error.  As an exam-
  3598.           ple, the following code waits on semaphore $semnum of
  3599.           semaphore id $semid:
  3600.  
  3601.                          $semop = pack("sss", $semnum, -1, 0);
  3602.                          die "Semaphore trouble: $!\n" unless semop($semid, $semop);
  3603.  
  3604.           To signal the semaphore, replace "-1" with "1".
  3605. æKY send
  3606. æDT send(SOCKET,MSG,FLAGS,TO)
  3607. æC send(SOCKET,MSG,FLAGS,TO)
  3608. send(SOCKET,MSG,FLAGS)
  3609.  
  3610.           Sends a message on a socket.  Takes the same flags as the
  3611.           system call of the same name.  On unconnected sockets you
  3612.           must specify a destination to send TO.  Returns the
  3613.           number of characters sent, or the undefined value if
  3614.           there is an error.
  3615. æKY setpgrp
  3616. æDT setpgrp(PID,PGRP)
  3617. æC setpgrp(PID,PGRP)
  3618.  
  3619.           Sets the current process group for the specified PID, 0
  3620.           for the current process.  Will produce a fatal error if
  3621.           used on a machine that doesn't implement setpgrp(2).
  3622. æKY setpriority
  3623. æDT setpriority(WHICH,WHO,PRIORITY)
  3624. æC setpriority(WHICH,WHO,PRIORITY)
  3625.  
  3626.           Sets the current priority for a process, a process group,
  3627.           or a user.  (See setpriority(2).) Will produce a fatal
  3628.           error if used on a machine that doesn't implement set-
  3629.           priority(2).
  3630. æKY setsockopt
  3631. æDT setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
  3632. æC setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
  3633.  
  3634.           Sets the socket option requested.  Returns undefined if
  3635.           there is an error.  OPTVAL may be specified as undef if
  3636.           you don't want to pass an argument.
  3637. æKY shift
  3638. æDT shift(ARRAY)
  3639. æC shift(ARRAY)
  3640. shift ARRAY
  3641. shift
  3642.           Shifts the first value of the array off and returns it,
  3643.           shortening the array by 1 and moving everything down.  If
  3644.           there are no elements in the array, returns the undefined
  3645.           value.  If ARRAY is omitted, shifts the @ARGV array in
  3646.           the main program, and the @_ array in subroutines.  (This
  3647.           is determined lexically.) See also unshift(), push() and
  3648.           pop().  Shift() and unshift() do the same thing to the
  3649.           left end of an array that push() and pop() do to the
  3650.           right end.
  3651. æKY shmctl
  3652. æDT shmctl(ID,CMD,ARG)
  3653. æC shmctl(ID,CMD,ARG)
  3654.  
  3655.           Calls the System V IPC function shmctl.  If CMD is
  3656.           &IPC_STAT, then ARG must be a variable which will hold
  3657.           the returned shmid_ds structure.  Returns like ioctl: the
  3658.           undefined value for error, "0 but true" for zero, or the
  3659.           actual return value otherwise.
  3660. æKY shmget
  3661. æDT shmget(KEY,SIZE,FLAGS)
  3662. æC shmget(KEY,SIZE,FLAGS)
  3663.  
  3664.           Calls the System V IPC function shmget.  Returns the
  3665.           shared memory segment id, or the undefined value if there
  3666.           is an error.
  3667. æKY shmread
  3668. æDT shmread(ID,VAR,POS,SIZE)
  3669. æC shmread(ID,VAR,POS,SIZE)
  3670. shmwrite(ID,STRING,POS,SIZE)
  3671.  
  3672.           Reads or writes the System V shared memory segment ID
  3673.           starting at position POS for size SIZE by attaching to
  3674.           it, copying in/out, and detaching from it.  When reading,
  3675.           VAR must be a variable which will hold the data read.
  3676.           When writing, if STRING is too long, only SIZE bytes are
  3677.           used; if STRING is too short, nulls are written to fill
  3678.           out SIZE bytes.  Return true if successful, or false if
  3679.           there is an error.
  3680. æKY shutdown
  3681. æDT shutdown(SOCKET,HOW)
  3682. æC shutdown(SOCKET,HOW)
  3683.  
  3684.           Shuts down a socket connection in the manner indicated by
  3685.           HOW, which has the same interpretation as in the system
  3686.           call of the same name.
  3687. æKY sin
  3688. æDT sin(EXPR)
  3689. æC sin(EXPR)
  3690. sin EXPR
  3691.  
  3692.           Returns the sine of EXPR (expressed in radians).  If EXPR
  3693.           is omitted, returns sine of $_.
  3694. æKY sleep
  3695. æDT sleep(EXPR)
  3696. æC sleep(EXPR)
  3697. sleep EXPR
  3698. sleep
  3699.  
  3700.           Causes the script to sleep for EXPR seconds, or forever
  3701.           if no EXPR.  May be interrupted by sending the process a
  3702.           SIGALRM.  Returns the number of seconds actually slept.
  3703.           You probably cannot mix alarm() and sleep() calls, since
  3704.           sleep() is often implemented using alarm().
  3705. æKY socket
  3706. æDT socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
  3707. æC socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
  3708.  
  3709.           Opens a socket of the specified kind and attaches it to
  3710.           filehandle SOCKET.  DOMAIN, TYPE and PROTOCOL are speci-
  3711.           fied the same as for the system call of the same name.
  3712.           You may need to run h2ph on sys/socket.h to get the
  3713.           proper values handy in a perl library file.  Return true
  3714.           if successful.  See the example in the section on Inter-
  3715.           process Communication.
  3716. æKY socketpair
  3717. æDT socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
  3718. æC socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
  3719.  
  3720.           Creates an unnamed pair of sockets in the specified
  3721.           domain, of the specified type.  DOMAIN, TYPE and PROTOCOL
  3722.           are specified the same as for the system call of the same
  3723.           name.  If unimplemented, yields a fatal error.  Return
  3724.           true if successful.
  3725. æKY sort
  3726. æDT sort(SUBROUTINE LIST)
  3727. æC sort(SUBROUTINE LIST)
  3728. sort(LIST)
  3729. sort SUBROUTINE LIST
  3730. sort LIST
  3731.  
  3732.           Sorts the LIST and returns the sorted array value. Non-
  3733.           existent values of arrays are stripped out.  If SUBROUTINE
  3734.           or BLOCK is omitted, sorts in standard string comparison
  3735.           order.  If SUBROUTINE is specified, gives the name of a
  3736.           subroutine that returns an integer less than, equal to,
  3737.           or greater than 0, depending on how the elements of the
  3738.           array are to be ordered.  In the interests of efficiency
  3739.           the normal calling code for subroutines is bypassed, with
  3740.           the following effects: the subroutine may not be a recur-
  3741.           sive subroutine, and the two elements to be compared are
  3742.           passed into the subroutine not via @_ but as $a and $b
  3743.           (see example below).  They are passed by reference so
  3744.           don't modify $a and $b.  (The <=> and cmp operators are 
  3745.           extremely useful in such routines.) SUBROUTINE may be a
  3746.           scalar variable name, in which case the value provides
  3747.           the name of the subroutine to use.
  3748.           In place of a SUBROUTINE name, you can provide a BLOCK as
  3749.           an anonymous, in-line sort subroutine. Examples:
  3750.  
  3751.                          # sort lexically
  3752.                          @articles = sort @files;
  3753.  
  3754.                          # same thing, but with explicit sort routine
  3755.                          @articles = sort {$a cmp $b} @files;
  3756.  
  3757.                          # same thing in reversed order
  3758.                          @articles = sort {$b cmp $a} @files;
  3759.  
  3760.                          # sort numerically ascending
  3761.                          @articles = sort {$a <=> $b} @files;
  3762.  
  3763.                          # sort numerically descending
  3764.                          @articles = sort {$b <=> $a} @files;
  3765.  
  3766.                          # sort using explicit subroutine name
  3767.                          sub byage {
  3768.                              $age{$a} <=> $age{$b}; # presuming integers
  3769.                          }
  3770.                          @sortedclass = sort byage @class;
  3771.  
  3772.                          sub reverse { $b cmp $a; }
  3773.                          @harry = ('dog','cat','x','Cain','Abel');
  3774.                          @george = ('gone','chased','yz','Punished','Axed');
  3775.                          print sort @harry;
  3776.                               # prints AbelCaincatdogx
  3777.                          print sort reverse @harry;
  3778.                               # prints xdogcatCainAbel
  3779.                          print sort @george, 'to', @harry;
  3780.                               # prints AbelAxedCainPunishedcatchaseddoggonetoxyz
  3781. æKY splice
  3782. æDT splice(ARRAY,OFFSET,LENGTH,LIST)
  3783. æC splice(ARRAY,OFFSET,LENGTH,LIST)
  3784. splice(ARRAY,OFFSET,LENGTH)
  3785. splice(ARRAY,OFFSET)
  3786.  
  3787.           Removes the elements designated by OFFSET and LENGTH from
  3788.           an array, and replaces them with the elements of LIST, if
  3789.           any.  Returns the elements removed from the array.  The
  3790.           array grows or shrinks as necessary.  If LENGTH is omit-
  3791.           ted, removes everything from OFFSET onward.  The follow-
  3792.           ing equivalencies hold (assuming $[ == 0):
  3793.  
  3794.                          push(@a,$x,$y)                splice(@a,$#a+1,0,$x,$y)
  3795.                          pop(@a)                       splice(@a,-1)
  3796.                          shift(@a)                     splice(@a,0,1)
  3797.                          unshift(@a,$x,$y)             splice(@a,0,0,$x,$y)
  3798.                          $a[$x] = $y                   splice(@a,$x,1,$y);
  3799.  
  3800.           Example, assuming array lengths are passed before arrays:
  3801.  
  3802.                          sub aeq { # compare two array values
  3803.                               local(@a) = splice(@_,0,shift);
  3804.                               local(@b) = splice(@_,0,shift);
  3805.                               return 0 unless @a == @b;     # same len?
  3806.                               while (@a) {
  3807.                                         return 0 if pop(@a) ne pop(@b);
  3808.                               }
  3809.                               return 1;
  3810.                          }
  3811.                          if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... }
  3812. æKY split
  3813. æDT split(/PATTERN/,EXPR,LIMIT)
  3814. æC split(/PATTERN/,EXPR,LIMIT)
  3815. split(/PATTERN/,EXPR)
  3816. split(/PATTERN/)
  3817. split
  3818.  
  3819.           Splits a string into an array of strings, and returns it.
  3820.           (If not in an array context, returns the number of fields
  3821.           found and splits into the @_ array.  (In an array con-
  3822.           text, you can force the split into @_ by using ?? as the
  3823.           pattern delimiters, but it still returns the array
  3824.           value.)) If EXPR is omitted, splits the $_ string.  If
  3825.           PATTERN is also omitted, splits on whitespace
  3826.           (/[ \t\n]+/).  Anything matching PATTERN is taken to be a
  3827.           delimiter separating the fields.  (Note that the delim-
  3828.           iter may be longer than one character.) If LIMIT is
  3829.           specified, splits into no more than that many fields
  3830.           (though it may split into fewer).  If LIMIT is unspeci-
  3831.           fied, trailing null fields are stripped (which potential
  3832.           users of pop() would do well to remember).  A pattern
  3833.           matching the null string (not to be confused with a null
  3834.           pattern //, which is just one member of the set of pat-
  3835.           terns matching a null string) will split the value of
  3836.           EXPR into separate characters at each point it matches
  3837.           that way.  For example:
  3838.  
  3839.                          print join(':', split(/ */, 'hi there'));
  3840.  
  3841.           produces the output 'h:i:t:h:e:r:e'.
  3842.  
  3843.           The LIMIT parameter can be used to partially split a line
  3844.  
  3845.                          ($login, $passwd, $remainder) = split(/:/, $_, 3);
  3846.  
  3847.           (When assigning to a list, if LIMIT is omitted, perl sup-
  3848.           plies a LIMIT one larger than the number of variables in
  3849.           the list, to avoid unnecessary work.  For the list above
  3850.           LIMIT would have been 4 by default.  In time critical
  3851.           applications it behooves you not to split into more
  3852.           fields than you really need.)
  3853.  
  3854.           If the PATTERN contains parentheses, additional array
  3855.           elements are created from each matching substring in the
  3856.           delimiter.
  3857.  
  3858.                          split(/([,-])/,"1-10,20");
  3859.  
  3860.           produces the array value
  3861.  
  3862.                          (1,'-',10,',',20)
  3863.  
  3864.           The pattern /PATTERN/ may be replaced with an expression
  3865.           to specify patterns that vary at runtime.  (To do runtime
  3866.           compilation only once, use /$variable/o.) As a special
  3867.           case, specifying a space (' ') will split on white space
  3868.           just as split with no arguments does, but leading white
  3869.           space does NOT produce a null first field.  Thus,
  3870.           split(' ') can be used to emulate awk's default behavior,
  3871.           whereas split(/ /) will give you as many null initial
  3872.           fields as there are leading spaces.
  3873.  
  3874.           Example:
  3875.  
  3876.                          open(passwd, '/etc/passwd');
  3877.                          while (<passwd>) {
  3878.                               ($login, $passwd, $uid, $gid, $gcos, $home, $shell)
  3879.                                    = split(/:/);
  3880.                               ...
  3881.                          }
  3882.  
  3883.           (Note that $shell above will still have a newline on it.
  3884.           See chop().) See also join.
  3885. æKY sprintf
  3886. æDT sprintf(FORMAT,LIST)
  3887. æC sprintf(FORMAT,LIST)
  3888.  
  3889.           Returns a string formatted by the usual printf conven-
  3890.           tions.  The * character is not supported.
  3891. æKY sqrt
  3892. æDT sqrt(EXPR)
  3893. æC sqrt(EXPR)
  3894. sqrt EXPR
  3895.  
  3896.           Return the square root of EXPR.  If EXPR is omitted,
  3897.           returns square root of $_.
  3898. æKY srand
  3899. æDT srand(EXPR)
  3900. æC srand(EXPR)
  3901. srand EXPR
  3902.  
  3903.           Sets the random number seed for the rand operator.  If
  3904.           EXPR is omitted, does srand(time).
  3905. æKY stat
  3906. æDT stat(FILEHANDLE)
  3907. æC stat(FILEHANDLE)
  3908. stat FILEHANDLE
  3909. stat(EXPR)
  3910. stat SCALARVARIABLE
  3911.  
  3912.           Returns a 13-element array giving the statistics for a
  3913.           file, either the file opened via FILEHANDLE, or named by
  3914.           EXPR.  Returns a null list if the stat fails. Typically
  3915.           used as follows:
  3916.  
  3917.                     ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
  3918.                          $atime,$mtime,$ctime,$blksize,$blocks)
  3919.                                    = stat($filename);
  3920.  
  3921.           If stat is passed the special filehandle consisting of an
  3922.           underline, no stat is done, but the current contents of
  3923.           the stat structure from the last stat or filetest are
  3924.           returned.  Example:
  3925.  
  3926.                          if (-x $file && (($d) = stat(_)) && $d < 0) {
  3927.                               print "$file is executable NFS file\n";
  3928.                          }
  3929.           (This only works on machines for which the device number is negative under NFS.)
  3930. æKY study
  3931. æDT study(SCALAR)
  3932. æC study(SCALAR)
  3933. study SCALAR
  3934. study
  3935.  
  3936.           Takes extra time to study SCALAR ($_ if unspecified) in
  3937.           anticipation of doing many pattern matches on the string
  3938.           before it is next modified.  This may or may not save
  3939.           time, depending on the nature and number of patterns you
  3940.           are searching on, and on the distribution of character
  3941.           frequencies in the string to be searched--you probably
  3942.           want to compare runtimes with and without it to see which
  3943.           runs faster.  Those loops which scan for many short con-
  3944.           stant strings (including the constant parts of more com-
  3945.           plex patterns) will benefit most.  You may have only one
  3946.           study active at a time--if you study a different scalar
  3947.           the first is "unstudied".  (The way study works is this:
  3948.           a linked list of every character in the string to be
  3949.           searched is made, so we know, for example, where all the
  3950.           'k' characters are.  From each search string, the rarest
  3951.           character is selected, based on some static frequency
  3952.           tables constructed from some C programs and English text.
  3953.           Only those places that contain this "rarest" character
  3954.           are examined.)
  3955.  
  3956.           For example, here is a loop which inserts index producing
  3957.           entries before any line containing a certain pattern:
  3958.  
  3959.                          while (<>) {
  3960.                               study;
  3961.                               print ".IX foo\n" if /\bfoo\b/;
  3962.                               print ".IX bar\n" if /\bbar\b/;
  3963.                               print ".IX blurfl\n" if /\bblurfl\b/;
  3964.                               ...
  3965.                               print;
  3966.                          }
  3967.  
  3968.           In searching for /\bfoo\b/, only those locations in $_
  3969.           that contain 'f' will be looked at, because 'f' is rarer
  3970.           than 'o'.  In general, this is a big win except in patho-
  3971.           logical cases.  The only question is whether it saves you
  3972.           more time than it took to build the linked list in the
  3973.           first place.
  3974.  
  3975.           Note that if you have to look for strings that you don't
  3976.           know till runtime, you can build an entire loop as a
  3977.           string and eval that to avoid recompiling all your pat-
  3978.           terns all the time.  Together with undefining $/ to input
  3979.           entire files as one record, this can be very fast, often
  3980.           faster than specialized programs like fgrep.  The follow-
  3981.           ing scans a list of files (@files) for a list of words
  3982.           (@words), and prints out the names of those files that
  3983.           contain a match:
  3984.  
  3985.                          $search = 'while (<>) { study;';
  3986.                          foreach $word (@words) {
  3987.                              $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n";
  3988.                          }
  3989.                          $search .= "}";
  3990.                          @ARGV = @files;
  3991.                          undef $/;
  3992.                          eval $search;       # this screams
  3993.                          $/ = "\n";          # put back to normal input delim
  3994.                          foreach $file (sort keys(%seen)) {
  3995.                              print $file, "\n";
  3996.                          }
  3997. æKY substr
  3998. æDT substr(EXPR,OFFSET,LEN)
  3999. æC substr(EXPR,OFFSET,LEN)
  4000. substr(EXPR,OFFSET)
  4001.  
  4002.           Extracts a substring out of EXPR and returns it.  First
  4003.           character is at offset 0, or whatever you've set $[ to.
  4004.           If OFFSET is negative, starts that far from the end of
  4005.           the string.  If LEN is omitted, returns everything to the
  4006.           end of the string.  You can use the substr() function as
  4007.           an lvalue, in which case EXPR must be an lvalue.  If you
  4008.           assign something shorter than LEN, the string will
  4009.           shrink, and if you assign something longer than LEN, the
  4010.           string will grow to accommodate it.  To keep the string
  4011.           the same length you may need to pad or chop your value
  4012.           using sprintf().
  4013. æKY symlink
  4014. æDT symlink(OLDFILE,NEWFILE)
  4015. æC symlink(OLDFILE,NEWFILE)
  4016.  
  4017.           Creates a new filename symbolically linked to the old
  4018.           filename.  Returns 1 for success, 0 otherwise.  On sys-
  4019.           tems that don't support symbolic links, produces a fatal
  4020.           error at run time.  To check for that, use eval:
  4021.  
  4022.                          $symlink_exists = (eval 'symlink("","");', $@ eq '');
  4023. æKY syscall
  4024. æDT syscall(LIST)
  4025. æC syscall(LIST)
  4026. syscall LIST
  4027.  
  4028.           Calls the system call specified as the first element of
  4029.           the list, passing the remaining elements as arguments to
  4030.           the system call.  If unimplemented, produces a fatal
  4031.           error.  The arguments are interpreted as follows: if a
  4032.           given argument is numeric, the argument is passed as an
  4033.           int.  If not, the pointer to the string value is passed.
  4034.           You are responsible to make sure a string is pre-extended
  4035.           long enough to receive any result that might be written
  4036.           into a string.  If your integer arguments are not
  4037.           literals and have never been interpreted in a numeric
  4038.           context, you may need to add 0 to them to force them to
  4039.           look like numbers.
  4040.  
  4041.                          require 'syscall.ph';         # may need to run h2ph
  4042.                          syscall(&SYS_write, fileno(STDOUT), "hi there\n", 9);
  4043. æKY sysread
  4044. æDT sysread(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  4045. æC sysread(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  4046. sysread(FILEHANDLE,SCALAR,LENGTH)
  4047.  
  4048.           Attempts to read LENGTH bytes of data into variable
  4049.           SCALAR from the specified FILEHANDLE, using the system
  4050.           call read(2).  It bypasses stdio, so mixing this with
  4051.           other kinds of reads may cause confusion.  Returns the
  4052.           number of bytes actually read, or undef if there was an
  4053.           error.  SCALAR will be grown or shrunk to the length
  4054.           actually read.  An OFFSET may be specified to place the
  4055.           read data at some other place than the beginning of the
  4056.           string.
  4057. æKY system
  4058. æDT system(LIST)
  4059. æC system(LIST)
  4060. system LIST
  4061.  
  4062.           Does exactly the same thing as "exec LIST" except that a
  4063.           fork is done first, and the parent process waits for the
  4064.           child process to complete.  Note that argument processing
  4065.           varies depending on the number of arguments.  The return
  4066.           value is the exit status of the program as returned by
  4067.           the wait() call.  To get the actual exit value divide by
  4068.           256.  See also exec.
  4069. æKY syswrite
  4070. æDT syswrite(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  4071. æC syswrite(FILEHANDLE,SCALAR,LENGTH,OFFSET)
  4072. syswrite(FILEHANDLE,SCALAR,LENGTH)
  4073.  
  4074.           Attempts to write LENGTH bytes of data from variable
  4075.           SCALAR to the specified FILEHANDLE, using the system call
  4076.           write(2).  It bypasses stdio, so mixing this with prints
  4077.           may cause confusion.  Returns the number of bytes actu-
  4078.           ally written, or undef if there was an error.  An OFFSET
  4079.           may be specified to place the read data at some other
  4080.           place than the beginning of the string.
  4081. æKY tell
  4082. æDT tell(FILEHANDLE)
  4083. æC tell(FILEHANDLE)
  4084. tell FILEHANDLE
  4085. tell
  4086.           Returns the current file position for FILEHANDLE.
  4087.           FILEHANDLE may be an expression whose value gives the
  4088.           name of the actual filehandle.  If FILEHANDLE is omitted,
  4089.           assumes the file last read.
  4090. æKY telldir
  4091. æDT telldir(DIRHANDLE)
  4092. æC telldir(DIRHANDLE)
  4093. telldir DIRHANDLE
  4094.  
  4095.           Returns the current position of the readdir() routines on
  4096.           DIRHANDLE.  Value may be given to seekdir() to access a
  4097.           particular location in a directory.  Has the same caveats
  4098.           about possible directory compaction as the corresponding
  4099.           system library routine.
  4100. æKY time
  4101. æDT time
  4102. æC time
  4103.  
  4104.           Returns the number of non-leap seconds since 00:00:00
  4105.           UTC, January 1, 1970.  Suitable for feeding to gmtime()
  4106.           and localtime().
  4107. æKY times
  4108. æDT times
  4109. æC times
  4110.  
  4111.           Returns a four-element array giving the user and system
  4112.           times, in seconds, for this process and the children of
  4113.           this process.
  4114.  
  4115.                     ($user,$system,$cuser,$csystem) = times;
  4116. æKY tr
  4117. æDT tr/SEARCHLIST/REPLACEMENTLIST/cds
  4118. æC tr/SEARCHLIST/REPLACEMENTLIST/cds
  4119. y/SEARCHLIST/REPLACEMENTLIST/cds
  4120.  
  4121.           Translates all occurrences of the characters found in the
  4122.           search list with the corresponding character in the
  4123.           replacement list.  It returns the number of characters
  4124.           replaced or deleted.  If no string is specified via the
  4125.           =~ or !~ operator, the $_ string is translated.  (The
  4126.           string specified with =~ must be a scalar variable, an
  4127.           array element, or an assignment to one of those, i.e. an
  4128.           lvalue.) For sed devotees, y is provided as a synonym for
  4129.           tr.  If the SEARCHLIST is delimited by bracketing quotes,
  4130.           the REPLACEMENTLIST has its own pair of quotes, which may
  4131.           or may not be bracketing quotes, e.g. tr[A-Z][a-z] or
  4132.           tr(+-*/)/ABCD/.
  4133.  
  4134.           If the c modifier is specified, the SEARCHLIST character
  4135.           set is complemented.  If the d modifier is specified, any
  4136.           characters specified by SEARCHLIST that are not found in
  4137.           REPLACEMENTLIST are deleted.  (Note that this is slightly
  4138.           more flexible than the behavior of some tr programs,
  4139.           which delete anything they find in the SEARCHLIST,
  4140.           period.) If the s modifier is specified, sequences of
  4141.           characters that were translated to the same character are
  4142.           squashed down to 1 instance of the character.
  4143.  
  4144.           If the d modifier was used, the REPLACEMENTLIST is always
  4145.           interpreted exactly as specified.  Otherwise, if the
  4146.           REPLACEMENTLIST is shorter than the SEARCHLIST, the final
  4147.           character is replicated till it is long enough.  If the
  4148.           REPLACEMENTLIST is null, the SEARCHLIST is replicated.
  4149.           This latter is useful for counting characters in a class,
  4150.           or for squashing character sequences in a class.
  4151.  
  4152.           Examples:
  4153.  
  4154.                     $ARGV[1] =~ y/A-Z/a-z/;   # canonicalize to lower case
  4155.  
  4156.                     $cnt = tr/*/*/;           # count the stars in $_
  4157.  
  4158.                     $cnt = tr/0-9//;          # count the digits in $_
  4159.  
  4160.                     tr/a-zA-Z//s;             # bookkeeper -> bokeper
  4161.  
  4162.                     ($HOST = $host) =~ tr/a-z/A-Z/;
  4163.  
  4164.                     y/a-zA-Z/ /cs;            # change non-alphas to single space
  4165.  
  4166.                     tr/\200-\377/\0-\177/;    # delete 8th bit
  4167. æKY truncate
  4168. æDT truncate(FILEHANDLE,LENGTH)
  4169. æC truncate(FILEHANDLE,LENGTH)
  4170. truncate(EXPR,LENGTH)
  4171.  
  4172.           Truncates the file opened on FILEHANDLE, or named by
  4173.           EXPR, to the specified length.  Produces a fatal error if
  4174.           truncate isn't implemented on your system.
  4175. æKY umask
  4176. æDT umask(EXPR)
  4177. æC umask(EXPR)
  4178. umask EXPR
  4179. umask
  4180.  
  4181.           Sets the umask for the process and returns the old one.
  4182.           If EXPR is omitted, merely returns current umask.
  4183. æKY undef
  4184. æDT undef(EXPR)
  4185. æC undef(EXPR)
  4186. undef EXPR
  4187. undef
  4188.  
  4189.           Undefines the value of EXPR, which must be an lvalue.
  4190.           Use only on a scalar value, an entire array, or a subrou-
  4191.           tine name (using &).  (Undef will probably not do what
  4192.           you expect on most predefined variables or dbm array
  4193.           values.) Always returns the undefined value.  You can
  4194.           omit the EXPR, in which case nothing is undefined, but
  4195.           you still get an undefined value that you could, for
  4196.           instance, return from a subroutine.  Examples:
  4197.  
  4198.                          undef $foo;
  4199.                          undef $bar{'blurfl'};
  4200.                          undef @ary;
  4201.                          undef %assoc;
  4202.                          undef &mysub;
  4203.                          return (wantarray ? () : undef) if $they_blew_it;
  4204. æKY unlink
  4205. æDT unlink(LIST)
  4206. æC unlink(LIST)
  4207. unlink LIST
  4208.  
  4209.           Deletes a list of files.  Returns the number of files
  4210.           successfully deleted.
  4211.  
  4212.                          $cnt = unlink 'a', 'b', 'c';
  4213.                          unlink @goners;
  4214.                          unlink <*.bak>;
  4215.  
  4216.           Note: unlink will not delete directories unless you are
  4217.           superuser and the -U flag is supplied to perl.  Even if
  4218.           these conditions are met, be warned that unlinking a
  4219.           directory can inflict damage on your filesystem.  Use
  4220.           rmdir instead.
  4221. æKY unpack
  4222. æDT unpack(TEMPLATE,EXPR)
  4223. æC unpack(TEMPLATE,EXPR)
  4224.  
  4225.           Unpack does the reverse of pack: it takes a string
  4226.           representing a structure and expands it out into an array
  4227.           value, returning the array value.  (In a scalar context,
  4228.           it merely returns the first value produced.) The TEMPLATE
  4229.           has the same format as in the pack function.  Here's a
  4230.           subroutine that does substring:
  4231.  
  4232.                          sub substr {
  4233.                               local($what,$where,$howmuch) = @_;
  4234.                               unpack("x$where a$howmuch", $what);
  4235.                          }
  4236.  
  4237.           and then there's
  4238.  
  4239.                          sub ord { unpack("c",$_[0]); }
  4240.  
  4241.           In addition, you may prefix a field with a %<number> to
  4242.           indicate that you want a <number>-bit checksum of the
  4243.           items instead of the items themselves.  Default is a 16-
  4244.           bit checksum.  For example, the following computes the
  4245.           same number as the System V sum program:
  4246.  
  4247.                          while (<>) {
  4248.                          $checksum += unpack("%16C*", $_);
  4249.                          }
  4250.                          $checksum %= 65536;
  4251. æKY unshift
  4252. æDT unshift(ARRAY,LIST)
  4253. æC unshift(ARRAY,LIST)
  4254.  
  4255.           Does the opposite of a shift.  Or the opposite of a push,
  4256.           depending on how you look at it.  Prepends list to the
  4257.           front of the array, and returns the number of elements in
  4258.           the new array.
  4259.  
  4260.                          unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/;
  4261. æKY utime
  4262. æDT utime(LIST)
  4263. æC utime(LIST)
  4264. utime LIST
  4265.  
  4266.           Changes the access and modification times on each file of
  4267.           a list of files.  The first two elements of the list must
  4268.           be the NUMERICAL access and modification times, in that
  4269.           order.  Returns the number of files successfully changed.
  4270.           The inode modification time of each file is set to the
  4271.           current time.  Example of a "touch" command:
  4272.  
  4273.                          #!/usr/bin/perl
  4274.                          $now = time;
  4275.                          utime $now, $now, @ARGV;
  4276. æKY values
  4277. æDT values(ASSOC_ARRAY)
  4278. æC values(ASSOC_ARRAY)
  4279. values ASSOC_ARRAY
  4280.  
  4281.           Returns a normal array consisting of all the values of
  4282.           the named associative array.  The values are returned in
  4283.           an apparently random order, but it is the same order as
  4284.           either the keys() or each() function would produce on the
  4285.           same array.  See also keys() and each().
  4286. æKY vec
  4287. æDT vec(EXPR,OFFSET,BITS)
  4288. æC vec(EXPR,OFFSET,BITS)
  4289.  
  4290.           Treats a string as a vector of unsigned integers, and
  4291.           returns the value of the bitfield specified.  May also be
  4292.           assigned to.  BITS must be a power of two from 1 to 32.
  4293.  
  4294.           Vectors created with vec() can also be manipulated with
  4295.           the logical operators |, & and ^, which will assume a bit
  4296.           vector operation is desired when both operands are
  4297.           strings.  This interpretation is not enabled unless there
  4298.           is at least one vec() in your program, to protect older
  4299.           programs.
  4300.  
  4301.           To transform a bit vector into a string or array of 0's
  4302.           and 1's, use these:
  4303.  
  4304.                          $bits = unpack("b*", $vector);
  4305.                          @bits = split(//, unpack("b*", $vector));
  4306.  
  4307.           If you know the exact length in bits, it can be used in
  4308.           place of the *.
  4309. æKY wait
  4310. æDT wait
  4311. æC wait
  4312.  
  4313.           Waits for a child process to terminate and returns the
  4314.           pid of the deceased process, or -1 if there are no child
  4315.           processes.  The status is returned in $?.
  4316. æKY waitpid
  4317. æDT waitpid(PID,FLAGS)
  4318. æC waitpid(PID,FLAGS)
  4319.  
  4320.           Waits for a particular child process to terminate and
  4321.           returns the pid of the deceased process, or -1 if there
  4322.           is no such child process.  The status is returned in $?.
  4323.           If you say
  4324.  
  4325.                          require "sys/wait.h";
  4326.                          ...
  4327.                          waitpid(-1,&WNOHANG);
  4328.  
  4329.           then you can do a non-blocking wait for any process.
  4330.           Non-blocking wait is only available on machines support-
  4331.           ing either the waitpid (2) or wait4 (2) system calls.
  4332.           However, waiting for a particular pid with FLAGS of 0 is
  4333.           implemented everywhere.  (Perl emulates the system call
  4334.           by remembering the status values of processes that have
  4335.           exited but have not been harvested by the Perl script
  4336.           yet.)
  4337. æKY wantarray
  4338. æDT wantarray
  4339. æC wantarray
  4340.  
  4341.           Returns true if the context of the currently executing
  4342.           subroutine is looking for an array value.  Returns false
  4343.           if the context is looking for a scalar.
  4344.  
  4345.                          return wantarray ? () : undef;
  4346. æKY warn
  4347. æDT warn(LIST)
  4348. æC warn(LIST)
  4349. warn LIST
  4350.  
  4351.           Produces a message on STDERR just like "die", but doesn't
  4352.           exit.
  4353. æKY write
  4354. æDT write(FILEHANDLE)
  4355. æC write(FILEHANDLE)
  4356. write(EXPR)
  4357. write
  4358.  
  4359.           Writes a formatted record (possibly multi-line) to the
  4360.           specified file, using the format associated with that
  4361.           file.  By default the format for a file is the one having
  4362.           the same name is the filehandle, but the format for the
  4363.           current output channel (see select) may be set explicitly
  4364.           by assigning the name of the format to the $~ variable.
  4365.  
  4366.           Top of form processing is handled automatically: if there
  4367.           is insufficient room on the current page for the format-
  4368.           ted record, the page is advanced by writing a form feed,
  4369.           a special top-of-page format is used to format the new
  4370.           page header, and then the record is written. By default
  4371.           the top-of-page format is the name of the filehandle with
  4372.           "_TOP" appended, but it may be dynamicallly set to the
  4373.           format of your choice by assigning the name to the $^
  4374.           variable while the filehandle is selected. The number of
  4375.           lines remaining on the current page is in variable $-,
  4376.           which can be set to 0 to force a new page.
  4377.  
  4378.           If FILEHANDLE is unspecified, output goes to the current
  4379.           default output channel, which starts out as STDOUT but
  4380.           may be changed by the select operator.  If the FILEHANDLE
  4381.           is an EXPR, then the expression is evaluated and the
  4382.           resulting string is used to look up the name of the
  4383.           FILEHANDLE at run time.  For more on formats, see the
  4384.           section on formats later on.
  4385.  
  4386.           Note that write is NOT the opposite of read.
  4387.  
  4388. æKY Perl…Precedence
  4389. æC
  4390. Perl operators have the following associativity and precedence:
  4391.  
  4392. nonassoc  print printf exec system sort reverse
  4393.                          chmod chown kill unlink utime die return
  4394. left      ,
  4395. right     = += -= *= etc.
  4396. right     ?:
  4397. nonassoc  ..
  4398. left      ||
  4399. left      &&
  4400. left      | ^
  4401. left      &
  4402. nonassoc  == != <=> eq ne cmp
  4403. nonassoc  < > <= >= lt gt le ge
  4404. nonassoc  chdir exit eval reset sleep rand umask
  4405. nonassoc  -r -w -x etc.
  4406. left      << >>
  4407. left      + - .
  4408. left      * / % x
  4409. left      =~ !~
  4410. right     ! ~ and unary minus
  4411. right     **
  4412. nonassoc  ++ --
  4413. left      '('
  4414.  
  4415. As mentioned earlier, if any list operator (print, etc.) or any
  4416. unary operator (chdir, etc.) is followed by a left parenthesis as
  4417. the next token on the same line, the operator and arguments
  4418. within parentheses are taken to be of highest precedence, just
  4419. like a normal function call.  Examples:
  4420.  
  4421.      chdir $foo || die;       # (chdir $foo) || die
  4422.      chdir($foo) || die;      # (chdir $foo) || die
  4423.      chdir ($foo) || die;     # (chdir $foo) || die
  4424.      chdir +($foo) || die;    # (chdir $foo) || die
  4425.  
  4426. but, because * is higher precedence than ||:
  4427.  
  4428.      chdir $foo * 20;         # chdir ($foo * 20)
  4429.      chdir($foo) * 20;        # (chdir $foo) * 20
  4430.      chdir ($foo) * 20;       # (chdir $foo) * 20
  4431.      chdir +($foo) * 20;      # chdir ($foo * 20)
  4432.  
  4433.      rand 10 * 20;            # rand (10 * 20)
  4434.      rand(10) * 20;           # (rand 10) * 20
  4435.      rand (10) * 20;          # (rand 10) * 20
  4436.      rand +(10) * 20;         # rand (10 * 20)
  4437.  
  4438. In the absence of parentheses, the precedence of list operators
  4439. such as print, sort or chmod is either very high or very low
  4440. depending on whether you look at the left side of operator or the
  4441. right side of it.  For example, in
  4442.  
  4443.      @ary = (1, 3, sort 4, 2);
  4444.      print @ary;         # prints 1324
  4445.  
  4446. the commas on the right of the sort are evaluated before the
  4447. sort, but the commas on the left are evaluated after.  In other
  4448. words, list operators tend to gobble up all the arguments that
  4449. follow them, and then act like a simple term with regard to the
  4450. preceding expression.  Note that you have to be careful with
  4451. parens:
  4452.  
  4453.      # These evaluate exit before doing the print:
  4454.      print($foo, exit);  # Obviously not what you want.
  4455.      print $foo, exit;   # Nor is this.
  4456.  
  4457.      # These do the print before evaluating exit:
  4458.      (print $foo), exit; # This is what you want.
  4459.      print($foo), exit;  # Or this.
  4460.      print ($foo), exit; # Or even this.
  4461.  
  4462. Also note that
  4463.  
  4464.      print ($foo & 255) + 1, "\n";
  4465.  
  4466. probably doesn't do what you expect at first glance.
  4467.  
  4468. æKY Perl…Subroutines
  4469. æC
  4470. A subroutine may be declared as follows:
  4471.  
  4472.           sub NAME BLOCK
  4473.  
  4474.  
  4475. Any arguments passed to the routine come in as array @_, that is
  4476. ($_[0], $_[1], ...).  The array @_ is a local array, but its
  4477. values are references to the actual scalar parameters.  The
  4478. return value of the subroutine is the value of the last expres-
  4479. sion evaluated, and can be either an array value or a scalar
  4480. value.  Alternately, a return statement may be used to specify
  4481. the returned value and exit the subroutine.  To create local
  4482. variables see the local operator.
  4483.  
  4484. A subroutine is called using the do operator or the & operator.
  4485.  
  4486. Example:
  4487.  
  4488.      sub MAX {
  4489.                     local($max) = pop(@_);
  4490.                     foreach $foo (@_) {
  4491.                          $max = $foo if $max < $foo;
  4492.                     }
  4493.                     $max;
  4494.      }
  4495.  
  4496.      ...
  4497.      $bestday = &MAX($mon,$tue,$wed,$thu,$fri);
  4498.  
  4499. Example:
  4500.  
  4501.      # get a line, combining continuation lines
  4502.      #  that start with whitespace
  4503.      sub get_line {
  4504.                     $thisline = $lookahead;
  4505.                     line: while ($lookahead = <STDIN>) {
  4506.                          if ($lookahead =~ /^[ \t]/) {
  4507.                               $thisline .= $lookahead;
  4508.                          }
  4509.                          else {
  4510.                               last line;
  4511.                          }
  4512.                     }
  4513.                     $thisline;
  4514.      }
  4515.  
  4516.      $lookahead = <STDIN>;    # get first line
  4517.      while ($_ = do get_line()) {
  4518.                     ...
  4519.      }
  4520.  
  4521. Use array assignment to a local list to name your formal arguments:
  4522.  
  4523.      sub maybeset {
  4524.                     local($key, $value) = @_;
  4525.                     $foo{$key} = $value unless $foo{$key};
  4526.      }
  4527.  
  4528. This also has the effect of turning call-by-reference into call-
  4529. by-value, since the assignment copies the values.
  4530.  
  4531. Subroutines may be called recursively.  If a subroutine is called
  4532. using the & form, the argument list is optional.  If omitted, no
  4533. @_ array is set up for the subroutine; the @_ array at the time
  4534. of the call is visible to subroutine instead.
  4535.  
  4536.      do foo(1,2,3);      # pass three arguments
  4537.      &foo(1,2,3);        # the same
  4538.  
  4539.      do foo();      # pass a null list
  4540.      &foo();             # the same
  4541.      &foo;               # pass no arguments--more efficient
  4542.  
  4543.  
  4544. Passing By Reference
  4545.  
  4546. Sometimes you don't want to pass the value of an array to a sub-
  4547. routine but rather the name of it, so that the subroutine can
  4548. modify the global copy of it rather than working with a local
  4549. copy.  In perl you can refer to all the objects of a particular
  4550. name by prefixing the name with a star: *foo.  When evaluated, it
  4551. produces a scalar value that represents all the objects of that
  4552. name, including any filehandle, format or subroutine.  When
  4553. assigned to within a local() operation, it causes the name men-
  4554. tioned to refer to whatever * value was assigned to it.  Example:
  4555.  
  4556.      sub doubleary {
  4557.                local(*someary) = @_;
  4558.                foreach $elem (@someary) {
  4559.                     $elem *= 2;
  4560.                }
  4561.      }
  4562.      do doubleary(*foo);
  4563.      do doubleary(*bar);
  4564.  
  4565. Assignment to *name is currently recommended only inside a
  4566. local().  You can actually assign to *name anywhere, but the pre-
  4567. vious referent of *name may be stranded forever.  This may or may
  4568. not bother you.
  4569.  
  4570. Note that scalars are already passed by reference, so you can
  4571. modify scalar arguments without using this mechanism by referring
  4572. explicitly to the $_[nnn] in question.  You can modify all the
  4573. elements of an array by passing all the elements as scalars, but
  4574. you have to use the * mechanism to push, pop or change the size
  4575. of an array.  The * mechanism will probably be more efficient in
  4576. any case.
  4577.  
  4578. Since a *name value contains unprintable binary data, if it is
  4579. used as an argument in a print, or as a %s argument in a printf
  4580. or sprintf, it then has the value '*name', just so it prints out
  4581. pretty.
  4582.  
  4583. Even if you don't want to modify an array, this mechanism is use-
  4584. ful for passing multiple arrays in a single LIST, since normally
  4585. the LIST mechanism will merge all the array values so that you
  4586. can't extract out the individual arrays.
  4587.  
  4588. æKY Perl…Regexp
  4589. æC
  4590. Regular Expressions
  4591.  
  4592. The patterns used in pattern matching are regular expressions
  4593. such as those supplied in the Version 8 regexp routines.  (In
  4594. fact, the routines are derived from Henry Spencer's freely redis-
  4595. tributable reimplementation of the V8 routines.) In addition, \w
  4596. matches an alphanumeric character (including "_") and \W a nonal-
  4597. phanumeric.  Word boundaries may be matched by \b, and non-
  4598. boundaries by \B.  A whitespace character is matched by \s, non-
  4599. whitespace by \S.  A numeric character is matched by \d, non-
  4600. numeric by \D.  You may use \w, \s and \d within character
  4601. classes.  Also, \n, \r, \f, \t and \NNN have their normal
  4602. interpretations.  Within character classes \b represents back-
  4603. space rather than a word boundary.  Alternatives may be separated
  4604. by |.  The bracketing construct ( ... ) may also be used, in
  4605. which case \<digit> matches the digit'th substring.  (Outside of
  4606. the pattern, always use $ instead of \ in front of the digit.
  4607. The scope of $<digit> (and $`, $& and $') extends to the end of
  4608. the enclosing BLOCK or eval string, or to the next pattern match
  4609. with subexpressions.  The \<digit> notation sometimes works out-
  4610. side the current pattern, but should not be relied upon.) You may
  4611. have as many parentheses as you wish.  If you have more than 9
  4612. substrings, the variables $10, $11, ... refer to the correspond-
  4613. ing substring.  Within the pattern, \10, \11, etc. refer back to
  4614. substrings if there have been at least that many left parens
  4615. before the backreference.  Otherwise (for backward compatibilty)
  4616. \10 is the same as \010, a backspace, and \11 the same as \011, a
  4617. tab.  And so on.  (\1 through \9 are always backreferences.)
  4618.  
  4619. $+ returns whatever the last bracket match matched.  $& returns
  4620. the entire matched string.  ($0 used to return the same thing,
  4621. but not any more.) $` returns everything before the matched
  4622. string.  $' returns everything after the matched string.  Exam-
  4623. ples:
  4624.  
  4625.      s/^([^ ]*) *([^ ]*)/$2 $1/;   # swap first two words
  4626.      if (/Time: (..):(..):(..)/) {
  4627.                     $hours = $1;
  4628.                     $minutes = $2;
  4629.                     $seconds = $3;
  4630.      }
  4631.  
  4632. By default, the ^ character is only guaranteed to match at the
  4633. beginning of the string, the $ character only at the end (or
  4634. before the newline at the end) and perl does certain optimiza-
  4635. tions with the assumption that the string contains only one line.
  4636. The behavior of ^ and $ on embedded newlines will be incon-
  4637. sistent.  You may, however, wish to treat a string as a multi-
  4638. line buffer, such that the ^ will match after any newline within
  4639. the string, and $ will match before any newline.  At the cost of
  4640. a little more overhead, you can do this by setting the variable
  4641. $* to 1.  Setting it back to 0 makes perl revert to its old
  4642. behavior.
  4643.  
  4644. To facilitate multi-line substitutions, the . character never
  4645. matches a newline (even when $* is 0).  In particular, the fol-
  4646. lowing leaves a newline on the $_ string:
  4647.  
  4648.      $_ = <STDIN>;
  4649.      s/.*(some_string).*/$1/;
  4650.  
  4651. If the newline is unwanted, try one of
  4652.  
  4653.      s/.*(some_string).*\n/$1/;
  4654.      s/.*(some_string)[^\000]*/$1/;
  4655.      s/.*(some_string)(.|\n)*/$1/;
  4656.      chop; s/.*(some_string).*/$1/;
  4657.      /(some_string)/ && ($_ = $1);
  4658.  
  4659. Any item of a regular expression may be followed with digits in
  4660. curly brackets of the form {n,m}, where n gives the minimum
  4661. number of times to match the item and m gives the maximum.  The
  4662. form {n} is equivalent to {n,n} and matches exactly n times.  The
  4663. form {n,} matches n or more times.  (If a curly bracket occurs in
  4664. any other context, it is treated as a regular character.) The *
  4665. modifier is equivalent to {0,}, the + modifier to {1,} and the ?
  4666. modifier to {0,1}.  There is no limit to the size of n or m, but
  4667. large numbers will chew up more memory.
  4668.  
  4669. You will note that all backslashed metacharacters in perl are
  4670. alphanumeric, such as \b, \w, \n.  Unlike some other regular
  4671. expression languages, there are no backslashed symbols that
  4672. aren't alphanumeric.  So anything that looks like \\, \(, \), \<,
  4673. \>, \{, or \} is always interpreted as a literal character, not a
  4674. metacharacter.  This makes it simple to quote a string that you
  4675. want to use for a pattern but that you are afraid might contain
  4676. metacharacters.  Simply quote all the non-alphanumeric charac-
  4677. ters:
  4678.  
  4679.      $pattern =~ s/(\W)/\\$1/g;
  4680. æKY Perl…Formats
  4681. æC
  4682. Output record formats for use with the write operator may
  4683. declared as follows:
  4684.  
  4685.           format NAME =
  4686.           FORMLIST
  4687.           .
  4688.  
  4689. If name is omitted, format "STDOUT" is defined.  FORMLIST con-
  4690. sists of a sequence of lines, each of which may be of one of
  4691. three types:
  4692.  
  4693. 1.  A comment.
  4694.  
  4695. 2.  A "picture" line giving the format for one output line.
  4696.  
  4697. 3.  An argument line supplying values to plug into a picture
  4698.     line.
  4699.  
  4700. Picture lines are printed exactly as they look, except for cer-
  4701. tain fields that substitute values into the line.  Each picture
  4702. field starts with either @ or ^.  The @ field (not to be confused
  4703. with the array marker @) is the normal case; ^ fields are used to
  4704. do rudimentary multi-line text block filling.  The length of the
  4705. field is supplied by padding out the field with multiple <, >, or
  4706. | characters to specify, respectively, left justification, right
  4707. justification, or centering.  As an alternate form of right jus-
  4708. tification, you may also use # characters (with an optional .) to
  4709. specify a numeric field.  (Use of ^ instead of @ causes the field
  4710. to be blanked if undefined.) If any of the values supplied for
  4711. these fields contains a newline, only the text up to the newline
  4712. is printed.  The special field @* can be used for printing
  4713. multi-line values.  It should appear by itself on a line.
  4714.  
  4715. The values are specified on the following line, in the same order
  4716. as the picture fields.  The values should be separated by commas.
  4717.  
  4718. Picture fields that begin with ^ rather than @ are treated spe-
  4719. cially.  The value supplied must be a scalar variable name which
  4720. contains a text string.  Perl puts as much text as it can into
  4721. the field, and then chops off the front of the string so that the
  4722. next time the variable is referenced, more of the text can be
  4723. printed.  Normally you would use a sequence of fields in a verti-
  4724. cal stack to print out a block of text.  If you like, you can end
  4725. the final field with ..., which will appear in the output if the
  4726. text was too long to appear in its entirety.  You can change
  4727. which characters are legal to break on by changing the variable
  4728. $: to a list of the desired characters.
  4729.  
  4730. Since use of ^ fields can produce variable length records if the
  4731. text to be formatted is short, you can suppress blank lines by
  4732. putting the tilde (~) character anywhere in the line.  (Normally
  4733. you should put it in the front if possible, for visibility.) The
  4734. tilde will be translated to a space upon output.  If you put a
  4735. second tilde contiguous to the first, the line will be repeated
  4736. until all the fields on the line are exhausted.  (If you use a
  4737. field of the @ variety, the expression you supply had better not
  4738. give the same value every time forever!)
  4739.  
  4740. Examples:
  4741.  
  4742. # a report on the /etc/passwd file
  4743. format STDOUT_TOP =
  4744.                                         Passwd File
  4745. Name                Login    Office   Uid   Gid Home
  4746. ------------------------------------------------------------------
  4747. .
  4748. format STDOUT =
  4749. @<<<<<<<<<<<<<<<<<< @||||||| @<<<<<<@>>>> @>>>> @<<<<<<<<<<<<<<<<<
  4750. $name,              $login,  $office,$uid,$gid, $home
  4751. .
  4752.  
  4753. # a report from a bug report form
  4754. format STDOUT_TOP =
  4755.                                         Bug Reports
  4756. @<<<<<<<<<<<<<<<<<<<<<<<     @|||         @>>>>>>>>>>>>>>>>>>>>>>>
  4757. $system,                      $%,         $date
  4758. ------------------------------------------------------------------
  4759. .
  4760. format STDOUT =
  4761. Subject: @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4762.                $subject
  4763. Index: @<<<<<<<<<<<<<<<<<<<<<<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4764.                $index,                       $description
  4765. Priority: @<<<<<<<<<< Date: @<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4766.                     $priority,        $date,   $description
  4767. From: @<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4768.           $from,                         $description
  4769. Assigned to: @<<<<<<<<<<<<<<<<<<<<<< ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4770.                          $programmer,            $description
  4771. ~                                    ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4772.                                                                  $description
  4773. ~                                    ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4774.                                                                  $description
  4775. ~                                    ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4776.                                                                  $description
  4777. ~                                    ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  4778.                                                                  $description
  4779. ~                                    ^<<<<<<<<<<<<<<<<<<<<<<<...
  4780.                                                                  $description
  4781. .
  4782.  
  4783. It is possible to intermix prints with writes on the same output
  4784. channel, but you'll have to handle $- (lines left on the page)
  4785. yourself.
  4786.  
  4787. If you are printing lots of fields that are usually blank, you
  4788. should consider using the reset operator between records.  Not
  4789. only is it more efficient, but it can prevent the bug of adding
  4790. another field and forgetting to zero it.
  4791. æKY Perl…IPC
  4792. æC
  4793. The IPC facilities of perl are built on the Berkeley socket
  4794. mechanism.  If you don't have sockets, you can ignore this sec-
  4795. tion.  The calls have the same names as the corresponding system
  4796. calls, but the arguments tend to differ, for two reasons.  First,
  4797. perl file handles work differently than C file descriptors.
  4798. Second, perl already knows the length of its strings, so you
  4799. don't need to pass that information.  Here is a sample client
  4800. (untested):
  4801.  
  4802.      ($them,$port) = @ARGV;
  4803.      $port = 2345 unless $port;
  4804.      $them = 'localhost' unless $them;
  4805.  
  4806.      $SIG{'INT'} = 'dokill';
  4807.      sub dokill { kill 9,$child if $child; }
  4808.  
  4809.      require 'sys/socket.ph';
  4810.  
  4811.      $sockaddr = 'S n a4 x8';
  4812.      chop($hostname = `hostname`);
  4813.  
  4814.      ($name, $aliases, $proto) = getprotobyname('tcp');
  4815.      ($name, $aliases, $port) = getservbyname($port, 'tcp')
  4816.                     unless $port =~ /^\d+$/;
  4817.      ($name, $aliases, $type, $len, $thisaddr) =
  4818.                                              gethostbyname($hostname);
  4819.      ($name, $aliases, $type, $len, $thataddr) = gethostbyname($them);
  4820.  
  4821.      $this = pack($sockaddr, &AF_INET, 0, $thisaddr);
  4822.      $that = pack($sockaddr, &AF_INET, $port, $thataddr);
  4823.  
  4824.      socket(S, &PF_INET, &SOCK_STREAM, $proto) || die "socket: $!";
  4825.      bind(S, $this) || die "bind: $!";
  4826.      connect(S, $that) || die "connect: $!";
  4827.  
  4828.      select(S); $| = 1; select(stdout);
  4829.  
  4830.      if ($child = fork) {
  4831.                     while (<>) {
  4832.                          print S;
  4833.                     }
  4834.                     sleep 3;
  4835.                     do dokill();
  4836.      }
  4837.      else {
  4838.                     while (<S>) {
  4839.                          print;
  4840.  
  4841. And here's a server:
  4842.  
  4843.      ($port) = @ARGV;
  4844.      $port = 2345 unless $port;
  4845.  
  4846.      require 'sys/socket.ph';
  4847.  
  4848.      $sockaddr = 'S n a4 x8';
  4849.  
  4850.      ($name, $aliases, $proto) = getprotobyname('tcp');
  4851.      ($name, $aliases, $port) = getservbyname($port, 'tcp')
  4852.                     unless $port =~ /^\d+$/;
  4853.  
  4854.      $this = pack($sockaddr, &AF_INET, $port, "\0\0\0\0");
  4855.  
  4856.      select(NS); $| = 1; select(stdout);
  4857.  
  4858.      socket(S, &PF_INET, &SOCK_STREAM, $proto) || die "socket: $!";
  4859.      bind(S, $this) || die "bind: $!";
  4860.      listen(S, 5) || die "connect: $!";
  4861.  
  4862.      select(S); $| = 1; select(stdout);
  4863.  
  4864.      for (;;) {
  4865.                     print "Listening again\n";
  4866.                     ($addr = accept(NS,S)) || die $!;
  4867.                     print "accept ok\n";
  4868.  
  4869.                     ($af,$port,$inetaddr) = unpack($sockaddr,$addr);
  4870.                     @inetaddr = unpack('C4',$inetaddr);
  4871.                     print "$af $port @inetaddr\n";
  4872.  
  4873.                     while (<NS>) {
  4874.                          print;
  4875.                          print NS;
  4876.                     }
  4877.      }
  4878. æKY Perl…Variables
  4879. æC
  4880. The following names have special meaning to perl.  I could have
  4881. used alphabetic symbols for some of these, but I didn't want to
  4882. take the chance that someone would say reset "a-zA-Z" and wipe
  4883. them all out.  You'll just have to suffer along with these silly
  4884. symbols.  Most of them have reasonable mnemonics, or analogues in
  4885. one of the shells.
  4886.  
  4887. $_      The default input and pattern-searching space.  The fol-
  4888.         lowing pairs are equivalent:
  4889.  
  4890.                        while (<>) {...     # only equivalent in while!
  4891.                        while ($_ = <>) {...
  4892.  
  4893.                        /^Subject:/
  4894.                        $_ =~ /^Subject:/
  4895.  
  4896.                        y/a-z/A-Z/
  4897.                        $_ =~ y/a-z/A-Z/
  4898.  
  4899.                        chop
  4900.                        chop($_)
  4901.  
  4902.         (Mnemonic: underline is understood in certain opera-
  4903.         tions.)
  4904.  
  4905. $.      The current input line number of the last filehandle that
  4906.         was read.  Readonly.  Remember that only an explicit
  4907.         close on the filehandle resets the line number.  Since <>
  4908.         never does an explicit close, line numbers increase
  4909.         across ARGV files (but see examples under eof).
  4910.         (Mnemonic: many programs use . to mean the current line
  4911.         number.)
  4912.  
  4913. $/      The input record separator, newline by default.  Works
  4914.         like awk's RS variable, including treating blank lines as
  4915.         delimiters if set to the null string.  You may set it to
  4916.         a multicharacter string to match a multi-character delim-
  4917.         iter.  Note that setting it to "\n\n" means something
  4918.         slightly different than setting it to "", if the file
  4919.         contains consecutive blank lines.  Setting it to "" will
  4920.         treat two or more consecutive blank lines as a single
  4921.         blank line. Setting it to "\n\n" will blindly assume that
  4922.         the next input character belongs to the next paragraph,
  4923.         even if it's a newline. (Mnemonic: / is used to delimit 
  4924.         line boundaries when quoting poetry.)
  4925.  
  4926. $,      The output field separator for the print operator.  Ordi-
  4927.         narily the print operator simply prints out the comma
  4928.         separated fields you specify.  In order to get behavior
  4929.         more like awk, set this variable as you would set awk's
  4930.         OFS variable to specify what is printed between fields.
  4931.         (Mnemonic: what is printed when there is a , in your
  4932.         print statement.)
  4933.  
  4934. $"      This is like $, except that it applies to array values
  4935.         interpolated into a double-quoted string (or similar
  4936.         interpreted string).  Default is a space.  (Mnemonic:
  4937.         obvious, I think.)
  4938.  
  4939. $\      The output record separator for the print operator.
  4940.         Ordinarily the print operator simply prints out the comma
  4941.         separated fields you specify, with no trailing newline or
  4942.         record separator assumed.  In order to get behavior more
  4943.         like awk, set this variable as you would set awk's ORS
  4944.         variable to specify what is printed at the end of the
  4945.         print.  (Mnemonic: you set $\ instead of adding \n at the
  4946.         end of the print.  Also, it's just like /, but it's what
  4947.         you get "back" from perl.)
  4948.  
  4949. $#      The output format for printed numbers.  This variable is
  4950.         a half-hearted attempt to emulate awk's OFMT variable.
  4951.         There are times, however, when awk and perl have differ-
  4952.         ing notions of what is in fact numeric.  Also, the ini-
  4953.         tial value is %.20g rather than %.6g, so you need to set
  4954.         $# explicitly to get awk's value.  (Mnemonic: # is the
  4955.         number sign.)
  4956.  
  4957. $%      The current page number of the currently selected output
  4958.         channel.  (Mnemonic: % is page number in nroff.)
  4959.  
  4960. $=      The current page length (printable lines) of the
  4961.         currently selected output channel.  Default is 60.
  4962.         (Mnemonic: = has horizontal lines.)
  4963.  
  4964. $-      The number of lines left on the page of the currently
  4965.         selected output channel.  (Mnemonic: lines_on_page -
  4966.         lines_printed.)
  4967.  
  4968. $~      The name of the current report format for the currently
  4969.         selected output channel.  (Mnemonic: brother to $^.)
  4970.         Default is name of the filehandle.
  4971.  
  4972. $^      The name of the current top-of-page format for the
  4973.         currently selected output channel.  (Mnemonic: points to
  4974.         top of page.)
  4975.         Default is name of the filehandle with "_TOP" appended.
  4976.  
  4977. $|      If set to nonzero, forces a flush after every write or
  4978.         print on the currently selected output channel.  Default
  4979.         is 0.  Note that STDOUT will typically be line buffered
  4980.         if output is to the terminal and block buffered other-
  4981.         wise.  Setting this variable is useful primarily when you
  4982.         are outputting to a pipe, such as when you are running a
  4983.         perl script under rsh and want to see the output as it's
  4984.         happening.  (Mnemonic: when you want your pipes to be
  4985.         piping hot.)
  4986.  
  4987. $$      The process number of the perl running this script.
  4988.         (Mnemonic: same as shells.)
  4989.  
  4990. $?      The status returned by the last pipe close, backtick (``)
  4991.         command or system operator.  Note that this is the status
  4992.         word returned by the wait() system call, so the exit
  4993.         value of the subprocess is actually ($? >> 8).  $? & 255
  4994.         gives which signal, if any, the process died from, and
  4995.         whether there was a core dump.  (Mnemonic: similar to sh
  4996.         and ksh.)
  4997.  
  4998. $&      The string matched by the last successful pattern match
  4999.         (not counting any matches hidden within a BLOCK or eval
  5000.         enclosed by the current BLOCK).  (Mnemonic: like & in some
  5001.         editors.)
  5002.  
  5003. $`      The string preceding whatever was matched by the last
  5004.         successful pattern match (not counting any matches hidden
  5005.         within a BLOCK or eval enclosed by the current BLOCK).
  5006.         (Mnemonic: ` often precedes a quoted string.)
  5007.  
  5008. $'      The string following whatever was matched by the last
  5009.         successful pattern match (not counting any matches hidden
  5010.         within a BLOCK or eval enclosed by the current BLOCK).
  5011.         (Mnemonic: ' often follows a quoted string.) Example:
  5012.  
  5013.                          $_ = 'abcdefghi';
  5014.                          /def/;
  5015.                          print "$`:$&:$'\n";      # prints abc:def:ghi
  5016.  
  5017.  
  5018. $+      The last bracket matched by the last search pattern.
  5019.         This is useful if you don't know which of a set of alter-
  5020.         native patterns matched.  For example:
  5021.  
  5022.                   /Version: (.*)|Revision: (.*)/ && ($rev = $+);
  5023.  
  5024.         (Mnemonic: be positive and forward looking.)
  5025.  
  5026. $*      Set to 1 to do multiline matching within a string, 0 to
  5027.         tell perl that it can assume that strings contain a sin-
  5028.         gle line, for the purpose of optimizing pattern matches.
  5029.         Pattern matches on strings containing multiple newlines
  5030.         can produce confusing results when $* is 0.  Default is
  5031.         0.  (Mnemonic: * matches multiple things.) Note that this
  5032.         variable only influences the interpretation of ^ and $.
  5033.         A literal newline can be searched for even when $* == 0.
  5034.  
  5035. $0      Contains the name of the file containing the perl script
  5036.         being executed.  Assigning to $0 modifies the argument
  5037.         area that the ps(1) program sees.  (Mnemonic: same as sh
  5038.         and ksh.)
  5039.  
  5040. $<digit>
  5041.         Contains the subpattern from the corresponding set of
  5042.         parentheses in the last pattern matched, not counting
  5043.         patterns matched in nested blocks that have been exited
  5044.         already.  (Mnemonic: like \digit.)
  5045.  
  5046. $[      The index of the first element in an array, and of the
  5047.         first character in a substring.  Default is 0, but you
  5048.         could set it to 1 to make perl behave more like awk (or
  5049.         Fortran) when subscripting and when evaluating the
  5050.         index() and substr() functions.  (Mnemonic: [ begins sub-
  5051.         scripts.)
  5052.  
  5053. $]      The string printed out when you say "perl -v".  It can be
  5054.         used to determine at the beginning of a script whether
  5055.         the perl interpreter executing the script is in the right
  5056.         range of versions.  If used in a numeric context, returns
  5057.         the version + patchlevel / 1000.  Example:
  5058.  
  5059.                        # see if getc is available
  5060.                             ($version,$patchlevel) =
  5061.                                  $] =~ /(\d+\.\d+).*\nPatch level: (\d+)/;
  5062.                             print STDERR "(No filename completion available.)\n"
  5063.                                  if $version * 1000 + $patchlevel < 2016;
  5064.  
  5065.         or, used numerically,
  5066.  
  5067.                        warn "No checksumming!\n" if $] < 3.019;
  5068.  
  5069.         (Mnemonic: Is this version of perl in the right bracket?)
  5070.  
  5071. $;      The subscript separator for multi-dimensional array emu-
  5072.         lation.  If you refer to an associative array element as
  5073.                        $foo{$a,$b,$c}
  5074.  
  5075.         it really means
  5076.  
  5077.                        $foo{join($;, $a, $b, $c)}
  5078.  
  5079.         But don't put
  5080.  
  5081.                        @foo{$a,$b,$c}      # a slice--note the @
  5082.  
  5083.         which means
  5084.  
  5085.                        ($foo{$a},$foo{$b},$foo{$c})
  5086.  
  5087.         Default is "\034", the same as SUBSEP in awk.  Note that
  5088.         if your keys contain binary data there might not be any
  5089.         safe value for $;.  (Mnemonic: comma (the syntactic sub-
  5090.         script separator) is a semi-semicolon.  Yeah, I know,
  5091.         it's pretty lame, but $, is already taken for something
  5092.         more important.)
  5093.  
  5094. $!      If used in a numeric context, yields the current value of
  5095.         errno, with all the usual caveats.  (This means that you
  5096.         shouldn't depend on the value of $! to be anything in
  5097.         particular unless you've gotten a specific error return
  5098.         indicating a system error.) If used in a string context,
  5099.         yields the corresponding system error string.  You can
  5100.         assign to $! in order to set errno if, for instance, you
  5101.         want $! to return the string for error n, or you want to
  5102.         set the exit value for the die operator.  (Mnemonic: What
  5103.         just went bang?)
  5104.  
  5105. $@      The perl syntax error message from the last eval command.
  5106.         If null, the last eval parsed and executed correctly
  5107.         (although the operations you invoked may have failed in
  5108.         the normal fashion).  (Mnemonic: Where was the syntax
  5109.         error "at"?)
  5110.  
  5111. $<      The real uid of this process.  (Mnemonic: it's the uid
  5112.         you came FROM, if you're running setuid.)
  5113.  
  5114. $>      The effective uid of this process.  Example:
  5115.  
  5116.                        $< = $>;  # set real uid to the effective uid
  5117.                        ($<,$>) = ($>,$<);  # swap real and effective uid
  5118.  
  5119.         (Mnemonic: it's the uid you went TO, if you're running
  5120.         setuid.) Note: $< and $> can only be swapped on machines
  5121.         supporting setreuid().
  5122.  
  5123. $(      The real gid of this process.  If you are on a machine
  5124.         that supports membership in multiple groups simultane-
  5125.         ously, gives a space separated list of groups you are in.
  5126.         The first number is the one returned by getgid(), and the
  5127.         subsequent ones by getgroups(), one of which may be the
  5128.         same as the first number.  (Mnemonic: parentheses are
  5129.         used to GROUP things.  The real gid is the group you
  5130.         LEFT, if you're running setgid.)
  5131.  
  5132. $)      The effective gid of this process.  If you are on a
  5133.         machine that supports membership in multiple groups
  5134.         simultaneously, gives a space separated list of groups
  5135.         you are in.  The first number is the one returned by
  5136.         getegid(), and the subsequent ones by getgroups(), one of
  5137.         which may be the same as the first number.  (Mnemonic:
  5138.         parentheses are used to GROUP things.  The effective gid
  5139.         is the group that's RIGHT for you, if you're running set-
  5140.         gid.)
  5141.  
  5142.         Note: $<, $>, $( and $) can only be set on machines that
  5143.         support the corresponding set[re][ug]id() routine.  $(
  5144.         and $) can only be swapped on machines supporting setre-
  5145.         gid().
  5146.  
  5147. $:      The current set of characters after which a string may be
  5148.         broken to fill continuation fields (starting with ^) in a
  5149.         format.  Default is " \n-", to break on whitespace or
  5150.         hyphens.  (Mnemonic: a "colon" in poetry is a part of a
  5151.         line.)
  5152.  
  5153. $^D     The current value of the debugging flags.  (Mnemonic:
  5154.         value of -D switch.)
  5155.  
  5156. $^F     The maximum system file descriptor, ordinarily 2.  System
  5157.         file descriptors are passed to subprocesses, while higher
  5158.         file descriptors are not. During an open, system file
  5159.         descriptors are preserved even if the open fails.  Ordinary
  5160.         file descriptors are closed before the open is attempted.
  5161.  
  5162. $^I     The current value of the inplace-edit extension.  Use
  5163.         undef to disable inplace editing.  (Mnemonic: value of -i
  5164.         switch.)
  5165.  
  5166. $^L     What formats output to perform a formfeed.  Default is \f.
  5167.  
  5168. $^P     The internal flag that the debugger clears so that it doesn't
  5169.         debug itself.  You could conceivable disable debugging yourself
  5170.         by clearing it.
  5171.  
  5172. $^T     The time at which the script began running, in seconds
  5173.         since the epoch.  The values returned by the -M , -A and
  5174.         -C filetests are based on this value.
  5175.  
  5176. $^W     The current value of the warning switch.  (Mnemonic:
  5177.         related to the -w switch.)
  5178.  
  5179. $^X     The name that Perl itself was invoked as, from argv[0].
  5180.  
  5181. $ARGV   contains the name of the current file when reading from
  5182.         <>.
  5183.  
  5184. @ARGV   The array ARGV contains the command line arguments
  5185.         intended for the script.  Note that $#ARGV is the gen-
  5186.         erally number of arguments minus one, since $ARGV[0] is
  5187.         the first argument, NOT the command name.  See $0 for the
  5188.         command name.
  5189.  
  5190. @INC    The array INC contains the list of places to look for
  5191.         perl scripts to be evaluated by the "do EXPR" command or
  5192.         the "require" command.  It initially consists of the
  5193.         arguments to any -I command line switches, followed by
  5194.         the default perl library, probably "/usr/local/lib/perl",
  5195.         followed by ".", to represent the current directory.
  5196.  
  5197. %INC    The associative array INC contains entries for each
  5198.         filename that has been included via "do" or "require".
  5199.         The key is the filename you specified, and the value is
  5200.         the location of the file actually found.  The "require"
  5201.         command uses this array to determine whether a given file
  5202.         has already been included.
  5203.  
  5204. $ENV{expr}
  5205.         The associative array ENV contains your current environ-
  5206.         ment.  Setting a value in ENV changes the environment for
  5207.         child processes.
  5208.  
  5209. $SIG{expr}
  5210.         The associative array SIG is used to set signal handlers
  5211.         for various signals.  Example:
  5212.  
  5213.                        sub handler {  # 1st argument is signal name
  5214.                             local($sig) = @_;
  5215.                             print "Caught a SIG$sig--shutting down\n";
  5216.                             close(LOG);
  5217.                             exit(0);
  5218.                        }
  5219.  
  5220.                        $SIG{'INT'} = 'handler';
  5221.                        $SIG{'QUIT'} = 'handler';
  5222.                        ...
  5223.                        $SIG{'INT'} = 'DEFAULT'; # restore default action
  5224.                        $SIG{'QUIT'} = 'IGNORE'; # ignore SIGQUIT
  5225.  
  5226.         The SIG array only contains values for the signals actu-
  5227.         ally set within the perl script.
  5228. æKY Perl…Packages
  5229. æC
  5230. Perl provides a mechanism for alternate namespaces to protect
  5231. packages from stomping on each others variables.  By default, a
  5232. perl script starts compiling into the package known as "main".
  5233. By use of the package declaration, you can switch namespaces.
  5234. The scope of the package declaration is from the declaration
  5235. itself to the end of the enclosing block (the same scope as the
  5236. local() operator).  Typically it would be the first declaration
  5237. in a file to be included by the "require" operator.  You can
  5238. switch into a package in more than one place; it merely influ-
  5239. ences which symbol table is used by the compiler for the rest of
  5240. that block.  You can refer to variables and filehandles in other
  5241. packages by prefixing the identifier with the package name and a
  5242. single quote.  If the package name is null, the "main" package as
  5243. assumed.
  5244.  
  5245. Only identifiers starting with letters are stored in the packages
  5246. symbol table.  All other symbols are kept in package "main".  In
  5247. addition, the identifiers STDIN, STDOUT, STDERR, ARGV, ARGVOUT,
  5248. ENV, INC and SIG are forced to be in package "main", even when
  5249. used for other purposes than their built-in one.  Note also that,
  5250. if you have a package called "m", "s" or "y", the you can't use
  5251. the qualified form of an identifier since it will be interpreted
  5252. instead as a pattern match, a substitution or a translation.
  5253.  
  5254. Eval'ed strings are compiled in the package in which the eval was
  5255. compiled in.  (Assignments to $SIG{}, however, assume the signal
  5256. handler specified is in the main package.  Qualify the signal
  5257. handler name if you wish to have a signal handler in a package.)
  5258. For an example, examine perldb.pl in the perl library.  It ini-
  5259. tially switches to the DB package so that the debugger doesn't
  5260. interfere with variables in the script you are trying to debug.
  5261. At various points, however, it temporarily switches back to the
  5262. main package to evaluate various expressions in the context of
  5263. the main package.
  5264.  
  5265. The symbol table for a package happens to be stored in the asso-
  5266. ciative array of that name prepended with an underscore.  The
  5267. value in each entry of the associative array is what you are
  5268. referring to when you use the *name notation.  In fact, the fol-
  5269. lowing have the same effect (in package main, anyway), though the
  5270. first is more efficient because it does the symbol table lookups
  5271. at compile time:
  5272.  
  5273.      local(*foo) = *bar;
  5274.      local($_main{'foo'}) = $_main{'bar'};
  5275.  
  5276. You can use this to print out all the variables in a package, for
  5277. instance.  Here is dumpvar.pl from the perl library:
  5278.  
  5279.      package dumpvar;
  5280.  
  5281.      sub main'dumpvar {
  5282.                ($package) = @_;
  5283.                local(*stab) = eval("*_$package");
  5284.                while (($key,$val) = each(%stab)) {
  5285.                          {
  5286.                          local(*entry) = $val;
  5287.                          if (defined $entry) {
  5288.                                    print "\$$key = '$entry'\n";
  5289.                          }
  5290.                          if (defined @entry) {
  5291.                                    print "\@$key = (\n";
  5292.                                    foreach $num ($[ .. $#entry) {
  5293.                                              print "  $num\t'",$entry[$num],"'\n";
  5294.                                    }
  5295.                                    print ")\n";
  5296.                          }
  5297.                          if ($key ne "_$package" && defined %entry) {
  5298.                                    print "\%$key = (\n";
  5299.                                    foreach $key (sort keys(%entry)) {
  5300.                                              print "  $key\t'",$entry{$key},"'\n";
  5301.                                    }
  5302.                                    print ")\n";
  5303.                          }
  5304.                          }
  5305.                }
  5306.      }
  5307.  
  5308. Note that, even though the subroutine is compiled in package
  5309. dumpvar, the name of the subroutine is qualified so that its name
  5310. is inserted into package "main".
  5311. æKY Perl…Style
  5312. æC
  5313. Each programmer will, of course, have his or her own preferences
  5314. in regards to formatting, but there are some general guidelines
  5315. that will make your programs easier to read.
  5316.  
  5317. 1.  Just because you CAN do something a particular way doesn't
  5318.     mean that you SHOULD do it that way.  Perl is designed to
  5319.     give you several ways to do anything, so consider picking the
  5320.     most readable one.  For instance
  5321.  
  5322.          open(FOO,$foo) || die "Can't open $foo: $!";
  5323.  
  5324.     is better than
  5325.  
  5326.          die "Can't open $foo: $!" unless open(FOO,$foo);
  5327.  
  5328.     because the second way hides the main point of the statement
  5329.     in a modifier.  On the other hand
  5330.  
  5331.          print "Starting analysis\n" if $verbose;
  5332.  
  5333.     is better than
  5334.  
  5335.          $verbose && print "Starting analysis\n";
  5336.  
  5337.     since the main point isn't whether the user typed -v or not.
  5338.  
  5339.     Similarly, just because an operator lets you assume default
  5340.     arguments doesn't mean that you have to make use of the
  5341.     defaults.  The defaults are there for lazy systems program-
  5342.     mers writing one-shot programs.  If you want your program to
  5343.     be readable, consider supplying the argument.
  5344.  
  5345.     Along the same lines, just because you can omit parentheses
  5346.     in many places doesn't mean that you ought to:
  5347.  
  5348.          return print reverse sort num values array;
  5349.          return print(reverse(sort num (values(%array))));
  5350.  
  5351.     When in doubt, parenthesize.  At the very least it will let
  5352.     some poor schmuck bounce on the % key in vi.
  5353.  
  5354.     Even if you aren't in doubt, consider the mental welfare of
  5355.     the person who has to maintain the code after you, and who
  5356.     will probably put parens in the wrong place.
  5357.  
  5358. 2.  Don't go through silly contortions to exit a loop at the top
  5359.     or the bottom, when perl provides the "last" operator so you
  5360.     can exit in the middle.  Just outdent it a little to make it
  5361.     more visible:
  5362.  
  5363.     line:
  5364.          for (;;) {
  5365.                    statements;
  5366.          last line if $foo;
  5367.                    next line if /^#/;
  5368.                    statements;
  5369.          }
  5370.  
  5371.  
  5372. 3.  Don't be afraid to use loop labels--they're there to enhance
  5373.     readability as well as to allow multi-level loop breaks.  See
  5374.     last example.
  5375.  
  5376. 4.  For portability, when using features that may not be imple-
  5377.     mented on every machine, test the construct in an eval to see
  5378.     if it fails.  If you know what version or patchlevel a par-
  5379.     ticular feature was implemented, you can test $] to see if it
  5380.     will be there.
  5381.  
  5382. 5.  Choose mnemonic identifiers.
  5383.  
  5384. 6.  Be consistent.
  5385. æKY Perl…Debugging
  5386. æC
  5387. If you invoke perl with a -d switch, your script will be run
  5388. under a debugging monitor.  It will halt before the first execut-
  5389. able statement and ask you for a command, such as:
  5390.  
  5391. h           Prints out a help message.
  5392.  
  5393. T           Stack trace.
  5394.  
  5395. s           Single step.  Executes until it reaches the beginning
  5396.             of another statement.
  5397.  
  5398. n           Next.  Executes over subroutine calls, until it
  5399.             reaches the beginning of the next statement.
  5400.  
  5401. f           Finish.  Executes statements until it has finished
  5402.             the current subroutine.
  5403.  
  5404. c           Continue.  Executes until the next breakpoint is
  5405.             reached.
  5406.  
  5407. c line      Continue to the specified line.  Inserts a one-time-
  5408.             only breakpoint at the specified line.
  5409.  
  5410. <CR>        Repeat last n or s.
  5411.  
  5412. l min+incr  List incr+1 lines starting at min.  If min is omit-
  5413.             ted, starts where last listing left off.  If incr is
  5414.             omitted, previous value of incr is used.
  5415.  
  5416. l min-max   List lines in the indicated range.
  5417.  
  5418. l line      List just the indicated line.
  5419.  
  5420. l           List next window.
  5421.  
  5422. -           List previous window.
  5423.  
  5424. w line      List window around line.
  5425.  
  5426. l subname   List subroutine.  If it's a long subroutine it just
  5427.             lists the beginning.  Use "l" to list more.
  5428.  
  5429. /pattern/   Regular expression search forward for pattern; the
  5430.             final / is optional.
  5431.  
  5432. ?pattern?   Regular expression search backward for pattern; the
  5433.             final ? is optional.
  5434.  
  5435. L           List lines that have breakpoints or actions.
  5436.  
  5437. S           Lists the names of all subroutines.
  5438.  
  5439. t           Toggle trace mode on or off.
  5440.  
  5441. b line condition
  5442.             Set a breakpoint.  If line is omitted, sets a break-
  5443.             point on the line that is about to be executed.  If a
  5444.             condition is specified, it is evaluated each time the
  5445.             statement is reached and a breakpoint is taken only
  5446.             if the condition is true.  Breakpoints may only be
  5447.             set on lines that begin an executable statement.
  5448.  
  5449. b subname condition
  5450.             Set breakpoint at first executable line of subrou-
  5451.             tine.
  5452.  
  5453. d line      Delete breakpoint.  If line is omitted, deletes the
  5454.             breakpoint on the line that is about to be executed.
  5455.  
  5456. D           Delete all breakpoints.
  5457.  
  5458. a line command
  5459.             Set an action for line.  A multi-line command may be
  5460.             entered by backslashing the newlines.
  5461.  
  5462. A           Delete all line actions.
  5463.  
  5464. < command   Set an action to happen before every debugger prompt.
  5465.             A multi-line command may be entered by backslashing
  5466.             the newlines.
  5467.  
  5468. > command   Set an action to happen after the prompt when you've
  5469.             just given a command to return to executing the
  5470.             script.  A multi-line command may be entered by
  5471.             backslashing the newlines.
  5472.  
  5473. V package   List all variables in package.  Default is main pack-
  5474.             age.
  5475.  
  5476. ! number    Redo a debugging command.  If number is omitted,
  5477.             redoes the previous command.
  5478.  
  5479. ! -number   Redo the command that was that many commands ago.
  5480.  
  5481. H -number   Display last n commands.  Only commands longer than
  5482.             one character are listed.  If number is omitted,
  5483.             lists them all.
  5484.  
  5485. q or ^D     Quit.
  5486.  
  5487. command     Execute command as a perl statement.  A missing semi-
  5488.             colon will be supplied.
  5489.  
  5490. p expr      Same as "print DB'OUT expr".  The DB'OUT filehandle
  5491.             is opened to /dev/tty, regardless of where STDOUT may
  5492.             be redirected to.
  5493.  
  5494. If you want to modify the debugger, copy perldb.pl from the perl
  5495. library to your current directory and modify it as necessary.
  5496. (You'll also have to put -I. on your command line.) You can do
  5497. some customization by setting up a .perldb file which contains
  5498. initialization code.  For instance, you could make aliases like
  5499. these:
  5500.  
  5501.           $DB'alias{'len'} = 's/^len(.*)/p length($1)/';
  5502.           $DB'alias{'stop'} = 's/^stop (at|in)/b/';
  5503.           $DB'alias{'.'} =
  5504.           's/^\./p "\$DB\'sub(\$DB\'line):\t",\$DB\'line[\$DB\'line]/';
  5505. æPerSetuid
  5506. æC
  5507. Setuid Scripts
  5508.  
  5509. Perl is designed to make it easy to write secure setuid and set-
  5510. gid scripts.  Unlike shells, which are based on multiple substi-
  5511. tution passes on each line of the script, perl uses a more con-
  5512. ventional evaluation scheme with fewer hidden "gotchas".  Addi-
  5513. tionally, since the language has more built-in functionality, it
  5514. has to rely less upon external (and possibly untrustworthy) pro-
  5515. grams to accomplish its purposes.
  5516.  
  5517. In an unpatched 4.2 or 4.3bsd kernel, setuid scripts are intrin-
  5518. sically insecure, but this kernel feature can be disabled.  If it
  5519. is, perl can emulate the setuid and setgid mechanism when it
  5520. notices the otherwise useless setuid/gid bits on perl scripts.
  5521. If the kernel feature isn't disabled, perl will complain loudly
  5522. that your setuid script is insecure.  You'll need to either dis-
  5523. able the kernel setuid script feature, or put a C wrapper around
  5524. the script.
  5525.  
  5526. When perl is executing a setuid script, it takes special precau-
  5527. tions to prevent you from falling into any obvious traps.  (In
  5528. some ways, a perl script is more secure than the corresponding C
  5529. program.) Any command line argument, environment variable, or
  5530. input is marked as "tainted", and may not be used, directly or
  5531. indirectly, in any command that invokes a subshell, or in any
  5532. command that modifies files, directories or processes.  Any vari-
  5533. able that is set within an expression that has previously refer-
  5534. enced a tainted value also becomes tainted (even if it is logi-
  5535. cally impossible for the tainted value to influence the vari-
  5536. able).  For example:
  5537.  
  5538.      $foo = shift;            # $foo is tainted
  5539.      $bar = $foo,'bar';       # $bar is also tainted
  5540.      $xxx = <>;               # Tainted
  5541.      $path = $ENV{'PATH'};    # Tainted, but see below
  5542.      $abc = 'abc';            # Not tainted
  5543.  
  5544.      system "echo $foo";      # Insecure
  5545.      system "/bin/echo", $foo;     # Secure (doesn't use sh)
  5546.      system "echo $bar";      # Insecure
  5547.      system "echo $abc";      # Insecure until PATH set
  5548.  
  5549.      $ENV{'PATH'} = '/bin:/usr/bin';
  5550.      $ENV{'IFS'} = '' if $ENV{'IFS'} ne '';
  5551.  
  5552.      $path = $ENV{'PATH'};    # Not tainted
  5553.      system "echo $abc";      # Is secure now!
  5554.  
  5555.      open(FOO,"$foo");        # OK
  5556.      open(FOO,">$foo");       # Not OK
  5557.  
  5558.      open(FOO,"echo $foo|");  # Not OK, but...
  5559.      open(FOO,"-|") || exec 'echo', $foo;    # OK
  5560.  
  5561.      $zzz = `echo $foo`;      # Insecure, zzz tainted
  5562.  
  5563.      unlink $abc,$foo;        # Insecure
  5564.      umask $foo;              # Insecure
  5565.  
  5566.      exec "echo $foo";        # Insecure
  5567.      exec "echo", $foo;       # Secure (doesn't use sh)
  5568.      exec "sh", '-c', $foo;   # Considered secure, alas
  5569.  
  5570. The taintedness is associated with each scalar value, so some
  5571. elements of an array can be tainted, and others not.
  5572.  
  5573. If you try to do something insecure, you will get a fatal error
  5574. saying something like "Insecure dependency" or "Insecure PATH".
  5575. Note that you can still write an insecure system call or exec,
  5576. but only by explicitly doing something like the last example
  5577. above.  You can also bypass the tainting mechanism by referencing
  5578. subpatterns--perl presumes that if you reference a substring
  5579. using $1, $2, etc, you knew what you were doing when you wrote
  5580. the pattern:
  5581.  
  5582.      $ARGV[0] =~ /^-P(\w+)$/;
  5583.      $printer = $1;      # Not tainted
  5584.  
  5585. This is fairly secure since \w+ doesn't match shell metacharac-
  5586. ters.  Use of .+ would have been insecure, but perl doesn't check
  5587. for that, so you must be careful with your patterns.  This is the
  5588. ONLY mechanism for untainting user supplied filenames if you want
  5589. to do file operations on them (unless you make $> equal to $<).
  5590.  
  5591. It's also possible to get into trouble with other operations that
  5592. don't care whether they use tainted values.  Make judicious use
  5593. of the file tests in dealing with any user-supplied filenames.
  5594. When possible, do opens and such after setting $> = $<.  Perl
  5595. doesn't prevent you from opening tainted filenames for reading,
  5596. so be careful what you print out.  The tainting mechanism is
  5597. intended to prevent stupid mistakes, not to remove the need for
  5598. thought.
  5599.  
  5600. æKY Perl…Environment
  5601. æC
  5602. HOME    Used if chdir has no argument.
  5603.  
  5604. LOGDIR  Used if chdir has no argument and HOME is not set.
  5605.  
  5606. Commands    Used in executing subprocesses, and in finding the script
  5607.         if -S is used.
  5608.  
  5609. PERLLIB A comma-separated list of directories in which to look for
  5610.         Perl library files before looking in the standard library
  5611.         and the current directory.
  5612.  
  5613. PERLDB  The command used to get the debugger code.  If unset, uses
  5614.  
  5615.             require 'perldb.pl'
  5616.  
  5617. Apart from these, perl uses no other environment variables, except
  5618. to make them available to the script being executed, and to child
  5619. processes.  However, scripts running setuid would do well to exe-
  5620. cute the following lines before doing anything else, just to keep
  5621. people honest:
  5622.  
  5623.           $ENV{'PATH'} = '/bin:/usr/bin';    # or whatever you need
  5624.           $ENV{'SHELL'} = '/bin/sh' if $ENV{'SHELL'} ne '';
  5625.           $ENV{'IFS'} = '' if $ENV{'IFS'} ne '';
  5626. æKY Perl…Diagnostics
  5627. æC
  5628. Compilation errors will tell you the line number of the error,
  5629. with an indication of the next token or token type that was to be
  5630. examined.  (In the case of a script passed to perl via -e
  5631. switches, each -e is counted as one line.)
  5632.  
  5633. Setuid scripts have additional constraints that can produce error
  5634. messages such as "Insecure dependency".  See the section on
  5635. setuid scripts.
  5636.  
  5637. æKY Perl…Traps
  5638. æC
  5639. Accustomed awk users should take special note of the following:
  5640.  
  5641. *   Semicolons are required after all simple statements in perl.
  5642.     (except at the end of a block).  Newline is not a statement
  5643.     delimiter.
  5644.  
  5645. *   Curly brackets are required on ifs and whiles.
  5646.  
  5647. *   Variables begin with $ or @ in perl.
  5648.  
  5649. *   Arrays index from 0 unless you set $[.  Likewise string posi-
  5650.     tions in substr() and index().
  5651.  
  5652. *   You have to decide whether your array has numeric or string
  5653.     indices.
  5654.  
  5655. *   Associative array values do not spring into existence upon
  5656.     mere reference.
  5657.  
  5658. *   You have to decide whether you want to use string or numeric
  5659.     comparisons.
  5660.  
  5661. *   Reading an input line does not split it for you.  You get to
  5662.     split it yourself to an array.  And the split operator has
  5663.     different arguments.
  5664.  
  5665. *   The current input line is normally in $_, not $0.  It gen-
  5666.     erally does not have the newline stripped.  ($0 is the name
  5667.     of the program executed.)
  5668.  
  5669. *   $<digit> does not refer to fields--it refers to substrings
  5670.     matched by the last match pattern.
  5671.  
  5672. *   The print statement does not add field and record separators
  5673.     unless you set $, and $\.
  5674.  
  5675. *   You must open your files before you print to them.
  5676.  
  5677. *   The range operator is "..", not comma.  (The comma operator
  5678.     works as in C.)
  5679.  
  5680. *   The match operator is "=~", not "~".  ("~" is the one's com-
  5681.     plement operator, as in C.)
  5682.  
  5683. *   The exponentiation operator is "**", not "^".  ("^" is the
  5684.     XOR operator, as in C.)
  5685.  
  5686. *   The concatenation operator is ".", not the null string.
  5687.     (Using the null string would render "/pat/ /pat/" unparsable,
  5688.     since the third slash would be interpreted as a division
  5689.     operator--the tokener is in fact slightly context sensitive
  5690.     for operators like /, ?, and <.  And in fact, . itself can be
  5691.     the beginning of a number.)
  5692.  
  5693. *   Next, exit and continue work differently.
  5694.  
  5695. *   The following variables work differently
  5696.  
  5697.          Awk               Perl
  5698.          ARGC              $#ARGV
  5699.          ARGV[0]           $0
  5700.          FILENAME          $ARGV
  5701.          FNR               $. - something
  5702.          FS                (whatever you like)
  5703.          NF                $#Fld, or some such
  5704.          NR                $.
  5705.          OFMT              $#
  5706.          OFS               $,
  5707.          ORS               $\
  5708.          RLENGTH           length($&)
  5709.          RS                $/
  5710.          RSTART            length($`)
  5711.          SUBSEP            $;
  5712.  
  5713.  
  5714. *   When in doubt, run the awk construct through a2p and see what
  5715.     it gives you.
  5716.  
  5717. Cerebral C programmers should take note of the following:
  5718.  
  5719. *   Curly brackets are required on ifs and whiles.
  5720.  
  5721. *   You should use "elsif" rather than "else if"
  5722.  
  5723. *   Break and continue become last and next, respectively.
  5724.  
  5725. *   There's no switch statement.
  5726.  
  5727. *   Variables begin with $ or @ in perl.
  5728.  
  5729. *   Printf does not implement *.
  5730.  
  5731. *   Comments begin with #, not /*.
  5732.  
  5733. *   You can't take the address of anything.
  5734.  
  5735. *   ARGV must be capitalized.
  5736.  
  5737. *   The "system" calls link, unlink, rename, etc. return nonzero
  5738.     for success, not 0.
  5739.  
  5740. *   Signal handlers deal with signal names, not numbers.
  5741.  
  5742. Seasoned sed programmers should take note of the following:
  5743.  
  5744. *   Backreferences in substitutions use $ rather than \.
  5745.  
  5746. *   The pattern matching metacharacters (, ), and | do not have
  5747.     backslashes in front.
  5748.  
  5749. *   The range operator is .. rather than comma.
  5750.  
  5751. Sharp shell programmers should take note of the following:
  5752.  
  5753. *   The backtick operator does variable interpretation without
  5754.     regard to the presence of single quotes in the command.
  5755.  
  5756. *   The backtick operator does no translation of the return
  5757.     value, unlike csh.
  5758.  
  5759. *   Shells (especially csh) do several levels of substitution on
  5760.     each command line.  Perl does substitution only in certain
  5761.     constructs such as double quotes, backticks, angle brackets
  5762.     and search patterns.
  5763.  
  5764. *   Shells interpret scripts a little bit at a time.  Perl com-
  5765.     piles the whole program before executing it.
  5766.  
  5767. *   The arguments are available via @ARGV, not $1, $2, etc.
  5768.  
  5769. *   The environment is not automatically made available as vari-
  5770.     ables.
  5771. æKY Perl…Errata
  5772. æC
  5773. The Perl book, Programming Perl, has the following omissions and
  5774. goofs.
  5775.  
  5776. On page 5, the examples which read
  5777.  
  5778.      eval "/usr/bin/perl
  5779.  
  5780. should read
  5781.  
  5782.      eval "exec /usr/bin/perl
  5783.  
  5784.  
  5785. On page 195, the equivalent to the System V sum program only
  5786. works for very small files.  To do larger files, use
  5787.  
  5788.      undef $/;
  5789.      $checksum = unpack("%32C*",<>) % 32767;
  5790.  
  5791. The descriptions of alarm and sleep refer to signal SIGALARM.
  5792. These should refer to SIGALRM.
  5793.  
  5794. The -0 switch to set the initial value of $/ was added to Perl
  5795. after the book went to press.
  5796.  
  5797. The -l switch now does automatic line ending processing.
  5798.  
  5799. The qx// construct is now a synonym for backticks.
  5800.  
  5801. $0 may now be assigned to set the argument displayed by ps (1).
  5802.  
  5803. The new @###.## format was omitted accidentally from the descrip-
  5804. tion on formats.
  5805.  
  5806. It wasn't known at press time that s///ee caused multiple evalua-
  5807. tions of the replacement expression.  This is to be construed as
  5808. a feature.
  5809.  
  5810. (LIST) x $count now does array replication.
  5811.  
  5812. There is now no limit on the number of parentheses in a regular
  5813. expression.
  5814.  
  5815. In double-quote context, more escapes are supported: \e, \a,
  5816. \x1b, \c[, \l, \L, \u, \U, \E.  The latter five control up/lower
  5817. case translation.
  5818.  
  5819. The $/ variable may now be set to a multi-character delimiter.
  5820.  
  5821. There is now a g modifier on ordinary pattern matching that causes it
  5822. to iterate through a string finding multiple matches.
  5823.  
  5824. All of the $^X variables are new except for $^T.
  5825.  
  5826. The default top-of-form format for FILEHANDLE is now FILEHANDLE_TOP rather
  5827. than top.
  5828.  
  5829. The eval {} and sort {} constructs were added in version 4.018.
  5830.  
  5831. The v and V (little-endian) template options for pack and unpack were
  5832. added in 4.019.
  5833. æKY Perl…Bugs
  5834. æC
  5835. Perl is at the mercy of your machine's definitions of various
  5836. operations such as type casting, atof() and sprintf().
  5837.  
  5838. If your stdio requires an seek or eof between reads and writes on
  5839. a particular stream, so does perl.
  5840.  
  5841. (This doesn't apply to sysread() and syswrite().)
  5842.  
  5843. While none of the built-in data types have any arbitrary size
  5844. limits (apart from memory size), there are still a few arbitrary
  5845. limits: a given identifier may not be longer than 255 characters;
  5846. and no component of your PATH may be longer than 255 if you use -S.
  5847. A regular expression may not compile to more than 32767 bytes
  5848. internally.
  5849.  
  5850. Perl actually stands for Pathologically Eclectic Rubbish Lister,
  5851. but don't tell anyone I said that.
  5852. æKY Perl…Macintosh…Extensions
  5853. æC
  5854. All Macintosh specific routines are currently defined in the MacPerl
  5855. package.
  5856.  
  5857. æKL MacPerl'Answer
  5858. MacPerl'Ask
  5859. MacPerl'Choose
  5860. MacPerl'DebugExternals
  5861. MacPerl'DoAppleScript
  5862. MacPerl'FAccess
  5863. MacPerl'GetFileInfo
  5864. MacPerl'LoadExternals
  5865. MacPerl'Pick
  5866. MacPerl'Quit
  5867. MacPerl'Reply
  5868. MacPerl'SetFileInfo
  5869. æKY Answer
  5870. MacPerl'Answer
  5871. æDT &MacPerl'Answer(PROMPT,BUTTON1,BUTTON2,BUTTON3)
  5872. æC &MacPerl'Answer(PROMPT)
  5873. &MacPerl'Answer(PROMPT,BUTTON1)
  5874. &MacPerl'Answer(PROMPT,BUTTON1,BUTTON2)
  5875. &MacPerl'Answer(PROMPT,BUTTON1,BUTTON2,BUTTON3)
  5876.  
  5877.           Presents to the user a dialog with 1, 2, or 3 buttons.
  5878.  
  5879.           Examples:
  5880.  
  5881.           &MacPerl'Answer("Nunc et in hora mortis nostrae", "Amen");
  5882.  
  5883.                             always returns 0.
  5884.  
  5885.           &MacPerl'Answer("I refuse");
  5886.  
  5887.                               is equivalent to answer("I refuse", "OK");
  5888.  
  5889.           &MacPerl'Answer("Delete hard disk ?", "OK", "Cancel");
  5890.  
  5891.                             returns 1 for OK, 0 for Cancel
  5892.  
  5893.           &MacPerl'Answer("Overwrite existig file", "Overwrite", "Skip", "Cancel");
  5894.  
  5895.                             returns 2 for Overwrite, 1 for Skip, 0 for Cancel
  5896. æKY Ask
  5897. MacPerl'Ask
  5898. æDT &MacPerl'Ask(PROMPT, DEFAULT)
  5899. æC &MacPerl'Ask(PROMPT, DEFAULT)
  5900. &MacPerl'Ask(PROMPT)
  5901.  
  5902.           Asks the user for a string. A default value may be given. Returns
  5903.           undef if the dialog is cancelled.
  5904.  
  5905.           Example:
  5906.  
  5907.           $phone = &MacPerl'Ask("Enter your phone number:");
  5908.           $name = &MacPerl'Ask("Enter your first name", "Bruce");
  5909.  
  5910.                             Useful for Australian database applications
  5911. æKY Pick
  5912. MacPerl'Pick
  5913. æDT MacPerl'Pick(PROMPT, VALUES)
  5914. æC MacPerl'Pick(PROMPT, VALUES)
  5915.  
  5916.           Asks the user to pick a choice from a list. VALUES is a list of choices.
  5917.           Returns undef if the dialog is cancelled.
  5918.  
  5919.           Examples:
  5920.  
  5921.           $color = MacPerl'Pick("What's your favorite color baby ?", "Red", "Green", "Gold")
  5922. æKY Choose
  5923. MacPerl'Choose
  5924. æDT &MacPerl'Choose(DOMAIN,TYPE,PROMPT,CONSTRAINT,FLAGS,DEFAULT)
  5925. æC &MacPerl'Choose(DOMAIN,TYPE,PROMPT,CONSTRAINT,FLAGS,DEFAULT)
  5926. &MacPerl'Choose(DOMAIN,TYPE,PROMPT,CONSTRAINT,FLAGS)
  5927. &MacPerl'Choose(DOMAIN,TYPE,PROMPT,CONSTRAINT)
  5928. &MacPerl'Choose(DOMAIN,TYPE,PROMPT)
  5929.  
  5930.          Puts up a modal dialog prompting the user to choose an address.
  5931.          DOMAIN specifies the communication domain, like for socket().
  5932.          TYPE may be used by future communication domains to further
  5933.          differentiate within a domain, but is ignored by current domains.
  5934.          PROMPT is a message that will appear in the dialog. CONSTRAINT may
  5935.          be set to a suitable packed value to restrict the types of acceptable
  5936.          addresses.
  5937.  
  5938.          Examples:
  5939.  
  5940.          require "GUSI.ph";
  5941.  
  5942.          $file =
  5943.             &MacPerl'Choose(
  5944.                &GUSI'AF_FILE, 0, "", 
  5945.                &GUSI'pack_sa_constr_file("OBJ ", "TEXT"));
  5946.  
  5947.                             Return the full pathname of an existing text
  5948.                             or MPW object file.
  5949.  
  5950.          $dir = &MacPerl'Choose(&GUSI'AF_FILE, 0, "", "", &GUSI'CHOOSE_DIR);
  5951.  
  5952.                             Return the full pathname of an existing directory.
  5953.  
  5954.          $file =
  5955.             &MacPerl'Choose(
  5956.                &GUSI'AF_FILE, 0, "", "", 
  5957.                &GUSI'CHOOSE_NEW + &GUSI'CHOOSE_DEFAULT, "yo");
  5958.  
  5959.                             Return the pathname of a new file to be created.
  5960.  
  5961. æKY SetFileInfo
  5962. MacPerl'SetFileInfo
  5963. æDT &MacPerl'SetFileInfo(CREATOR,TYPE,FILE...)
  5964. æC &MacPerl'SetFileInfo(CREATOR,TYPE,FILE...)
  5965.  
  5966.          Changes the file types and creators of the file(s).
  5967.  
  5968.          Examples:
  5969.  
  5970.         &MacPerl'SetFileInfo("MPS ", "TEXT", yin, yang);
  5971.  
  5972.                            Turn yin and yang into MPW text files
  5973.  
  5974. æKY GetFileInfo
  5975. MacPerl'GetFileInfo
  5976. æDT &MacPerl'SetFileInfo(FILE)
  5977. æC &MacPerl'SetFileInfo(FILE)
  5978.  
  5979.          In scalar context, returns the file type. In array context, returns
  5980.          (creator,type).
  5981.  
  5982.          Examples:
  5983.  
  5984.          &MacPerl'SetFileInfo(yin);
  5985.  
  5986.                            Returns "TEXT" or ("MPS ", "TEXT").
  5987.  
  5988. æKY DoAppleScript
  5989. MacPerl'DoAppleScript
  5990. æDT &MacPerl'DoAppleScript(SCRIPT)
  5991. æC &MacPerl'DoAppleScript(SCRIPT)
  5992.         Execute an AppleScript script.
  5993.  
  5994.         Example:
  5995.  
  5996.         &MacPerl'DoAppleScript(<<END_SCRIPT);
  5997.         tell application "MacPerl"
  5998.             make new Window
  5999.             copy "Inserting text the hard way." to character 1 of front Window
  6000.         end tell
  6001.         END_SCRIPT
  6002. æKY Reply
  6003. MacPerl'Reply
  6004. æDT &MacPerl'Reply(ANSWER)
  6005. æC &MacPerl'Reply(ANSWER)
  6006.         Reply to current DoScript request. Useful if you are calling Perl
  6007.         scripts from other applications.
  6008. æKY Quit
  6009. MacPerl'Quit
  6010. æDT &MacPerl'Quit(LEVEL)
  6011. æC &MacPerl'Quit(LEVEL)
  6012.         If Level is 0, don't quit after ending the script. If 1, quit if 
  6013.         running under a runtime version, if 2, always quit.
  6014. æKY LoadExternals
  6015. MacPerl'LoadExternals
  6016. æDT &MacPerl'LoadExternals(LIBFILE)
  6017. æC &MacPerl'LoadExternals(LIBFILE)
  6018.         Load XCMD and XFCN extensions contained in file LIBFILE, which is searched
  6019.         along the same path as it would be for a require. The extensions are made
  6020.         accessible in the current package, unless they conatin an explicit package
  6021.         name.
  6022. æKY DebugExternals
  6023. MacPerl'DebugExternals
  6024. æDT &MacPerl'DebugExternals(DEBUGLEVEL)
  6025. æC &MacPerl'DebugExternals(DEBUGLEVEL)
  6026.         If DEBUGLEVEL is 0, don't print any debug information for XCMDs and XFCNs. 
  6027.         If 1, print information for unimplemented callbacks. If 2, print
  6028.         informations for all callbacks.
  6029. æKY FAccess
  6030. MacPerl'FAccess
  6031. æDT &MacPerl'FAccess(FILE, CMD, ARG...)
  6032. æC &MacPerl'FAccess(FILE, CMD, ARG...)
  6033.         When called from the tool, manipulate various information of files. To
  6034.         get the command constants, it's convenient to require "FAccess.ph".
  6035.  
  6036.         $TAB = &MacPerl'FAccess(FILE, &F_GTABINFO)
  6037.         &MacPerl'FAccess(FILE, &F_STABINFO, TAB)
  6038.             Manipulate tabulator setting (in spaces per tab).
  6039.  
  6040.         ($FONTNAME, $FONTSIZE) = &MacPerl'FAccess(FILE, &F_GFONTINFO)
  6041.         $FONTNUM = &MacPerl'FAccess(FILE, &F_GFONTINFO)
  6042.         &MacPerl'FAccess(FILE, &F_SFONTINFO, FONT [, SIZE])
  6043.             Manipulate font and size information. Both font names and font numbers
  6044.             are accepted for F_SFONTINFO; F_GFONTINFO returns a font name in an
  6045.             array context, a font number in a scalar context.
  6046.  
  6047.         ($STARTSEL, $ENDSEL, $DISPLAYTOP) = &MacPerl'FAccess(FILE, &F_GSELINFO)
  6048.         $STARTSEL = &MacPerl'FAccess(FILE, &F_GSELINFO)
  6049.         &MacPerl'FAccess(FILE, &F_SSELINFO, $STARTSEL, $ENDSEL [, $DISPLAYTOP])
  6050.             Manipulate the MPW selection of a file.
  6051.  
  6052.         ($LEFT, $TOP, $RIGHT, $BOTTOM) = &MacPerl'FAccess(FILE, &F_GWININFO)
  6053.         $TOP = &MacPerl'FAccess(FILE, &F_GWININFO)
  6054.         &MacPerl'FAccess(FILE, &F_SWININFO, LEFT, TOP [, RIGHT, BOTTOM])
  6055.             Manipulate the window position.
  6056.